annotate docs/SMC15/smc2015template.tex @ 3141:335bc77627e0 tip

fixing discrete interface to allow labels to display
author Dave Moffat <me@davemoffat.com>
date Mon, 26 Jul 2021 12:15:24 +0100
parents 3f8996191f5b
children
rev   line source
b@1693 1 % -----------------------------------------------
b@1693 2 % Template for SMC 2012
b@1693 3 % adapted from the template for SMC 2011, which was adapted from that of SMC 2010
b@1693 4 % -----------------------------------------------
b@1693 5
b@1693 6 \documentclass{article}
b@1693 7 \usepackage{smc2015}
b@1693 8 \usepackage{times}
b@1693 9 \usepackage{ifpdf}
b@1693 10 \usepackage[english]{babel}
b@1693 11 \usepackage{cite}
b@1996 12 \usepackage{enumitem}
b@1543 13 \usepackage{listings}
b@1996 14 \setitemize{noitemsep,topsep=0pt,parsep=0pt,partopsep=0pt}
b@1693 15
b@1543 16
b@1543 17
b@1543 18 \usepackage{color}
b@1546 19 \definecolor{grey}{rgb}{0.1,0.1,0.1}
b@1543 20 \definecolor{darkblue}{rgb}{0.0,0.0,0.6}
b@1543 21 \definecolor{cyan}{rgb}{0.0,0.6,0.6}
b@1543 22
b@1543 23
b@1672 24 \hyphenation{Java-script}
nickjillings@1544 25 \hyphenation{OPA-QUE}
b@1672 26
b@1693 27 %%%%%%%%%%%%%%%%%%%%%%%% Some useful packages %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
b@1693 28 %%%%%%%%%%%%%%%%%%%%%%%% See related documentation %%%%%%%%%%%%%%%%%%%%%%%%%%
b@1693 29 %\usepackage{amsmath} % popular packages from Am. Math. Soc. Please use the
b@1693 30 %\usepackage{amssymb} % related math environments (split, subequation, cases,
b@1693 31 %\usepackage{amsfonts}% multline, etc.)
b@1693 32 %\usepackage{bm} % Bold Math package, defines the command \bf{}
b@1693 33 %\usepackage{paralist}% extended list environments
b@1693 34 %%subfig.sty is the modern replacement for subfigure.sty. However, subfig.sty
b@1693 35 %%requires and automatically loads caption.sty which overrides class handling
b@1693 36 %%of captions. To prevent this problem, preload caption.sty with caption=false
b@1693 37 %\usepackage[caption=false]{caption}
b@1693 38 %\usepackage[font=footnotesize]{subfig}
b@1693 39
b@1693 40
b@1693 41 %user defined variables
b@1669 42 \def\papertitle{WEB AUDIO EVALUATION TOOL: A BROWSER-BASED LISTENING TEST ENVIRONMENT} %?
b@1698 43 \def\firstauthor{Nicholas Jillings}
b@1698 44 \def\secondauthor{Brecht De Man}
b@1693 45 \def\thirdauthor{David Moffat}
b@1693 46 \def\fourthauthor{Joshua D. Reiss}
b@1693 47
b@1693 48 % adds the automatic
b@1693 49 % Saves a lot of ouptut space in PDF... after conversion with the distiller
b@1693 50 % Delete if you cannot get PS fonts working on your system.
b@1693 51
b@1693 52 % pdf-tex settings: detect automatically if run by latex or pdflatex
b@1693 53 \newif\ifpdf
b@1693 54 \ifx\pdfoutput\relax
b@1693 55 \else
b@1693 56 \ifcase\pdfoutput
b@1693 57 \pdffalse
b@1693 58 \else
b@1693 59 \pdftrue
b@1693 60 \fi
b@1693 61
b@1693 62 \ifpdf % compiling with pdflatex
b@1693 63 \usepackage[pdftex,
b@1693 64 pdftitle={\papertitle},
b@1693 65 pdfauthor={\firstauthor, \secondauthor, \thirdauthor},
b@1693 66 bookmarksnumbered, % use section numbers with bookmarks
b@1693 67 pdfstartview=XYZ % start with zoom=100% instead of full screen;
b@1693 68 % especially useful if working with a big screen :-)
b@1693 69 ]{hyperref}
b@1693 70 %\pdfcompresslevel=9
b@1693 71
b@1693 72 \usepackage[pdftex]{graphicx}
b@1693 73 % declare the path(s) where your graphic files are and their extensions so
b@1693 74 %you won't have to specify these with every instance of \includegraphics
b@1693 75 \graphicspath{{./figures/}}
b@1693 76 \DeclareGraphicsExtensions{.pdf,.jpeg,.png}
b@1693 77
b@1693 78 \usepackage[figure,table]{hypcap}
b@1693 79
b@1693 80 \else % compiling with latex
b@1693 81 \usepackage[dvips,
b@1693 82 bookmarksnumbered, % use section numbers with bookmarks
b@1693 83 pdfstartview=XYZ % start with zoom=100% instead of full screen
b@1693 84 ]{hyperref} % hyperrefs are active in the pdf file after conversion
b@1693 85
b@1693 86 \usepackage[dvips]{epsfig,graphicx}
b@1693 87 % declare the path(s) where your graphic files are and their extensions so
b@1693 88 %you won't have to specify these with every instance of \includegraphics
b@1693 89 \graphicspath{{./figures/}}
b@1693 90 \DeclareGraphicsExtensions{.eps}
b@1693 91
b@1693 92 \usepackage[figure,table]{hypcap}
b@1693 93 \fi
b@1693 94
nickjillings@1988 95 %set up the hyperref package - make the links black without a surrounding frame
b@1693 96 \hypersetup{
b@1693 97 colorlinks,%
b@1693 98 citecolor=black,%
b@1693 99 filecolor=black,%
b@1693 100 linkcolor=black,%
b@1693 101 urlcolor=black
b@1693 102 }
b@1693 103
b@1693 104
b@1693 105 % Title.
b@1693 106 % ------
b@1693 107 \title{\papertitle}
b@1693 108
b@1693 109 % Authors
b@1693 110 % Please note that submissions are NOT anonymous, therefore
b@1693 111 % authors' names have to be VISIBLE in your manuscript.
b@1693 112 %
b@1693 113 % Single address
b@1693 114 % To use with only one author or several with the same address
b@1693 115 % ---------------
b@1693 116 %\oneauthor
b@1693 117 % {\firstauthor} {Affiliation1 \\ %
b@1693 118 % {\tt \href{mailto:author1@smcnetwork.org}{author1@smcnetwork.org}}}
b@1693 119
b@1693 120 %Two addresses
b@1693 121 %--------------
b@1693 122 % \twoauthors
b@1693 123 % {\firstauthor} {Affiliation1 \\ %
b@1693 124 % {\tt \href{mailto:author1@smcnetwork.org}{author1@smcnetwork.org}}}
b@1693 125 % {\secondauthor} {Affiliation2 \\ %
b@1693 126 % {\tt \href{mailto:author2@smcnetwork.org}{author2@smcnetwork.org}}}
b@1693 127
b@1698 128
b@1698 129
b@1698 130 % FIX!!!
b@1693 131 \fourauthors
b@1693 132 {\firstauthor} {%Affiliation1 \\
b@1698 133 {\tt \href{mailto:b.deman@qmul.ac.uk}{n.g.r.jillings@se14.qmul.ac.uk, }}}
b@1693 134 {\secondauthor} {%Affiliation2\\ %
b@1698 135 {\tt \href{mailto:n.g.r.jillings@se14.qmul.ac.uk}{\{b.deman,}}}
b@1693 136 {\thirdauthor} {%Affiliation3\\ %
b@1698 137 {\tt \href{mailto:d.j.moffat@qmul.ac.uk}{d.j.moffat, }}}
b@1693 138 {\fourthauthor} {%Affiliation4\\ %
b@1698 139 {\tt \href{mailto:joshua.reiss@qmul.ac.uk}{joshua.reiss\}@qmul.ac.uk}}}
b@1693 140
b@1693 141 % ***************************************** the document starts here ***************
b@1693 142 \begin{document}
b@1693 143 %
b@1693 144 \capstartfalse
b@1693 145 \maketitle
b@1693 146 \capstarttrue
b@1693 147 %
b@1693 148 \begin{abstract}
b@1998 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.
b@1998 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.
nickjillings@1991 151 % Currently at 150, don't think anything more needs to be done here??
b@1669 152 %Place your abstract at the top left column on the first page.
b@1669 153 %Please write about 150-200 words that specifically highlight the purpose of your work,
b@1669 154 %its context, and provide a brief synopsis of your results.
b@1669 155 %Avoid equations in this part.\\
b@1669 156
b@1693 157 \end{abstract}
b@1977 158
b@1977 159 % TOTAL PAPER: Minimum 4 pages, 6 preferred, max. 8 (6 for demos/posters)\\
b@1693 160
b@1693 161 \section{Introduction}\label{sec:introduction}
b@1693 162
nickjillings@1676 163 %NICK: examples of what kind of audio applications HTML5 has made possible, with references to publications (or website)\\
nickjillings@1676 164
b@2000 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?
b@1981 166
b@1996 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.
b@1979 168
b@1987 169 % IMPORTANT
b@1987 170 %[TO ADD: other interfaces for perceptual evaluation of audio, browser-based or not!] \\
b@1987 171 %BROWSER-BASED: \cite{song2013b,song2013a,beaqlejs} \\
b@1987 172 %MATLAB: \cite{whisper,mushram,scale}
b@1987 173 % to add: OPAQUE, Rumsey's repertory grid technique
b@1987 174
b@1994 175
b@1994 176 \begin{table}[htdp]
b@1996 177 \caption{Available audio perceptual evaluation tools}
b@1994 178 \begin{center}
b@1994 179 \begin{tabular}{|*{3}{l|}}
b@1994 180 % order?
b@1994 181 \hline
b@1994 182 \textbf{Name} & \textbf{Language} & \textbf{Ref.}\\
b@1994 183 \hline
b@1994 184 APE & MATLAB & \cite{deman2014b} \\
b@1994 185 BeaqleJS & HTML5/JS & \cite{beaqlejs}\\ % ABX, mushra
b@1994 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}\\
b@1994 187 HULTI-GEN & Max & \cite{hulti-gen}\\
b@1994 188 MUSHRAM & MATLAB & \cite{mushram}\\ % type: mushra
b@1994 189 Scale & MATLAB & \cite{scale} \\
b@1994 190 WhisPER & MATLAB & \cite{whisper}\\
b@1994 191 \hline
b@1994 192 \end{tabular}
b@1994 193 \end{center}
b@1994 194 \label{tab:interfaces}
b@1994 195 \end{table}%
b@1994 196
b@1996 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.
b@1996 198
b@1996 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.
b@1996 200 Furthermore, compatibility is usually limited across different versions of MATLAB.
nickjillings@2040 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.
b@1547 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.
b@1996 203
b@1996 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.
b@1996 205
b@1996 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/},
b@1996 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/}.
b@1996 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}.
b@1996 209
b@1996 210
b@1994 211
b@1987 212 % [How is this one different from all these?] improve
b@1984 213
b@1994 214 % FLEXIBLE (reference (not) appropriate)
b@1996 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.
b@1994 216 % EASE OF USE: no need to go in the code
b@1994 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.
b@1994 218
b@1996 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.
b@1996 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.
nickjillings@1988 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.
b@1984 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.
b@1996 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.
b@1994 224
b@1987 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.
b@1698 226
b@1994 227 %\section{Requirements}\label{sec:requirements}
b@1994 228 %???
b@1994 229 %
b@1994 230 %\begin{itemize}
b@1994 231 %\item
b@1994 232 %\end{itemize}
b@1981 233 \section{Interface}\label{sec:interface}
b@1698 234
b@1996 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.
b@1996 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.
b@1998 237
b@1998 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.
b@1998 239
b@1547 240 See Figure \ref{fig:interface} for an example of the interface. %? change if a new interface is shown
b@1984 241
b@1998 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.
b@1998 243 %There are some areas of the design where certain design choices had to be made such as with the markers.
b@1998 244
b@1996 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.
b@1641 246
me@1986 247 \begin{figure*}[ht]
b@1543 248 \centering
b@1545 249 \includegraphics[width=.95\textwidth]{interface.png}
b@1547 250 \caption{Example interface, with one axis, seven fragments, and text, radio button and check box style comments.}
b@1979 251 \label{fig:interface}
b@1979 252 \end{figure*}
me@1986 253
me@1986 254
b@1981 255 \section{Architecture}\label{sec:architecture} % or implementation?
b@1981 256
b@1998 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.
nickjillings@1700 258
nickjillings@1700 259 The web tool itself is split into several files to operate:
nickjillings@1700 260 \begin{itemize}
nickjillings@1679 261 \item \texttt{index.html}: The main index file to load the scripts, this is the file the browser must request to load.
nickjillings@1991 262 \item \texttt{core.js}: Contains global functions and object prototypes to define the audio playback engine, audio objects and loading media files
b@1998 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}.
nickjillings@1700 264 \end{itemize}
nickjillings@1700 265
b@1547 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}.
nickjillings@1700 267
b@2386 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.
b@1984 269
b@1998 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}.
b@1998 271 These are custom audio nodes, one representing each audio element specified in each page.
b@1547 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?
nickjillings@1679 273 % audio object/audioObject/Audio Object: -- should always be audioObject if talking about the JavaScript object, otherwise should say audio element or audio fragment.
b@1984 274
b@1998 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.
nickjillings@1679 276
nickjillings@1679 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}.
nickjillings@1679 278
b@1547 279 \vspace{-1em}
b@1547 280
b@2000 281 \section{Support and limitations}\label{sec:support}
b@1998 282
b@1547 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
nickjillings@1679 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.
b@1999 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.
nickjillings@1991 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.
b@1984 287
b@1984 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.
b@1984 289 % Don't think this is relevant anymore
b@1984 290
b@1998 291
b@1987 292 \section{Input and result files}\label{sec:setupresultsformats}
b@1984 293
b@1547 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.
b@1543 295
b@1543 296
b@1543 297
b@1543 298
b@1543 299 \lstset{
b@1543 300 basicstyle=\ttfamily,
b@1543 301 columns=fullflexible,
b@1543 302 showstringspaces=false,
b@1546 303 commentstyle=\color{grey}\upshape
b@1543 304 }
b@1543 305
b@1543 306 \lstdefinelanguage{XML}
b@1543 307 {
b@1543 308 morestring=[b]",
b@1543 309 morestring=[s]{>}{<},
b@1543 310 morecomment=[s]{<?}{?>},
b@1543 311 stringstyle=\color{black} \bfseries,
b@1543 312 identifierstyle=\color{darkblue} \bfseries,
b@1543 313 keywordstyle=\color{cyan} \bfseries,
b@1543 314 morekeywords={xmlns,version,type},
b@1543 315 breaklines=true% list your attributes here
b@1543 316 }
b@1546 317 \scriptsize
b@1543 318 \lstset{language=XML}
b@1543 319
b@1543 320 \begin{lstlisting}
b@1543 321 <?xml version="1.0" encoding="utf-8"?>
b@1543 322 <BrowserEvalProjectDocument>
b@1543 323 <setup interface="APE" projectReturn="/save" randomiseOrder='false' collectMetrics='true'>
b@1543 324 <PreTest>
b@1543 325 <question id="location" mandatory="true">Please enter your location.</question>
b@1543 326 <number id="age" min="0">Please enter your age</number>
b@1543 327 </PreTest>
b@1543 328 <PostTest>
b@1543 329 <statement>Thank you for taking this listening test!</statement>
b@1543 330 </PostTest>
b@1543 331 <Metric>
b@1543 332 <metricEnable>testTimer</metricEnable>
b@1543 333 <metricEnable>elementTimer</metricEnable>
b@1543 334 <metricEnable>elementInitialPosition</metricEnable>
b@1543 335 <metricEnable>elementTracker</metricEnable>
b@1543 336 <metricEnable>elementFlagListenedTo</metricEnable>
b@1543 337 <metricEnable>elementFlagMoved</metricEnable>
b@1543 338 </Metric>
b@1543 339 <interface>
b@1543 340 <anchor>20</anchor>
b@1543 341 <reference>80</reference>
b@1543 342 </interface>
b@1543 343 </setup>
b@1543 344 <audioHolder id="test-0" hostURL="example_eval/" randomiseOrder='true'>
b@1543 345 <interface>
b@1543 346 <title>Example Test Question</title>
b@1543 347 <scale position="0">Min</scale>
b@1543 348 <scale position="100">Max</scale>
b@1543 349 <commentBoxPrefix>Comment on fragment</commentBoxPrefix>
b@1543 350 </interface>
nickjillings@1544 351 <audioElements url="1.wav" id="elem1"/>
nickjillings@1544 352 <audioElements url="2.wav" id="elem2"/>
nickjillings@1544 353 <audioElements url="3.wav" id="elem3"/>
b@1543 354 <CommentQuestion id="generalExperience" type="text">General Comments</CommentQuestion>
b@1543 355 <PreTest/>
b@1543 356 <PostTest>
nickjillings@1544 357 <question id="songGenre" mandatory="true">Please enter the genre of the song.</question>
b@1543 358 </PostTest>
b@1543 359 </audioHolder>
nickjillings@1544 360 </BrowserEvalProjectDocument>
b@1543 361
b@1543 362 \end{lstlisting}
b@1543 363
b@1543 364 \normalsize
b@1546 365 \vspace{-1em}
b@1984 366
b@1999 367 \subsection{Setup and configurability}
b@1984 368
nickjillings@1544 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.
b@1984 370
b@1999 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.
b@1984 372
b@1543 373 \begin{itemize}[leftmargin=*]%Should have used a description list for this.
b@1547 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.
b@1547 375 \item \textbf{Loop fragments}: Repeat current fragment when end is reached, until the `Stop' or `Submit' button is clicked.
b@1984 376 \item \textbf{Comments}: Displays a separate comment box for each fragment in the page.
nickjillings@1544 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.
b@1547 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.
b@1984 379 \item \textbf{Randomise page order}: Randomises the order in which different `pages' are presented. % are we calling this 'pages'?
b@1547 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').
b@1547 381 \item \textbf{Require (full) playback}: Require that each fragment has been played at least once, partly or fully.
b@1984 382 \item \textbf{Require moving}: Require that each marker is moved (dragged) at least once.
b@1547 383 \item \textbf{Require comments}: Require the subject to write a comment for each fragment.
b@1547 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.
b@1984 385 \item \textbf{Returning to previous pages}: Indicates whether it is possible to go back to a previous `page' in the test.
b@1984 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.
b@1984 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.
b@1984 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}.
b@1547 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.
b@1547 390 Similarly, a `hidden anchor' should be rated lower than a certain value \cite{mushra}.
nickjillings@2040 391 \item \textbf{Show scrub bar}: Display a playhead on a scrub bar to show the position in the current fragment.
nickjillings@2040 392 %\item \textbf{Drag playhead}: If scrub bar is visible, allow dragging to move back or forward in a fragment.
b@1984 393 \end{itemize}
b@1984 394
b@1999 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.
b@1984 396
b@1984 397 % loop, snap to corresponding position, comments, 'general' comment, require same sampling rate, different types of randomisation
b@1984 398
b@1987 399 \subsection{Results}
b@1987 400
b@1547 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.
me@1986 402
b@1546 403 \scriptsize
b@1543 404 \lstset{language=XML}
b@1984 405
b@1543 406 \begin{lstlisting}
nickjillings@1544 407 <browserevaluationresult>
nickjillings@1544 408 <datetime>
nickjillings@1544 409 <date year="2015" month="5" day="28">2015/5/28</date>
nickjillings@1544 410 <time hour="13" minute="19" secs="17">13:19:17</time>
nickjillings@1544 411 </datetime>
nickjillings@1544 412 <pretest>
nickjillings@1544 413 <comment id="location">Control Room</comment>
nickjillings@1544 414 </pretest>
nickjillings@1544 415 <audioholder>
nickjillings@1544 416 <pretest></pretest>
nickjillings@1544 417 <posttest>
b@1546 418 <comment id="songGenre">Pop</comment>
nickjillings@1544 419 </posttest>
nickjillings@1544 420 <metric>
b@1546 421 <metricresult id="testTime">813.32</metricresult>
nickjillings@1544 422 </metric>
b@1546 423 <audioelement id="elem1">
nickjillings@1544 424 <comment>
b@1547 425 <question>Comment on fragment 1</question>
b@1546 426 <response>Good, but vocals too quiet.</response>
nickjillings@1544 427 </comment>
nickjillings@1544 428 <value>0.639010989010989</value>
nickjillings@1544 429 <metric>
b@1546 430 <metricresult id="elementTimer">111.05</metricresult>
nickjillings@1544 431 <metricresult id="elementTrackerFull">
nickjillings@1544 432 <timepos id="0">
b@1546 433 <time>61.60</time>
b@1546 434 <position>0.6390</position>
nickjillings@1544 435 </timepos>
nickjillings@1544 436 </metricresult>
b@1546 437 <metricresult id="elementInitialPosition">0.6571</metricresult>
nickjillings@1544 438 <metricresult id="elementFlagListenedTo">true</metricresult>
nickjillings@1544 439 </metric>
nickjillings@1544 440 </audioelement>
nickjillings@1544 441 </audioHolder>
nickjillings@1544 442 </browserevaluationresult>
b@1984 443
b@1543 444 \end{lstlisting}
b@1543 445
b@1543 446 \normalsize
b@1546 447 \vspace{-.5em}
b@1546 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.
nickjillings@1544 449 We also store session data such as the time the test took place and the duration of the test.
b@1987 450 We provide the option to store the results locally, and/or to have them sent to a server.
b@1984 451
nickjillings@1988 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)
b@1984 453 % Should we include an Example of the input and output XML structure?? --> Sure.
b@1984 454
me@1986 455 %An example of the returned \textit{audioElement} node in the results XML file is as follows.
me@1986 456 %
me@1986 457 %\texttt{<audioelement id="8"> \\
me@1986 458 %<comment> \\
me@1986 459 %<question>Comment on track 0</question> \\
me@1986 460 %<response> The drums were punchy </response> \\
me@1986 461 %</comment> \\
me@1986 462 %<value> 0.25169491525423726 </value> \\
me@1986 463 %<metric> \\
me@1986 464 %<metricresult id="elementTimer"> \\ 2.3278004535147385< /metricresult> \\
me@1986 465 %<metricresult id="elementTrackerFull"> \\
me@1986 466 %<timepos id="0"> \\
me@1986 467 %<time>1.7937414965986385</time> \\
me@1986 468 %<position>0.41694915254237286</position> \\
me@1986 469 %</timepos> \\
me@1986 470 %<timepos id="1"> \\
me@1986 471 %<time>2.6993197278911563</time> \\
me@1986 472 %<position>0.45847457627118643</position> \\
me@1986 473 %</timepos> \\</metricresult> \\
me@1986 474 %<metricresult id="elementInitialPosition"> 0.47796610169491527 </metricresult> \\
me@1986 475 %<metricresult id="elementFlagListenedTo"> true< /metricresult> \\
me@1986 476 %<metricresult id="elementFlagMoved"> true </metricresult> \\
me@1986 477 %</metric> \\
me@1986 478 %</audioelement>}
b@1984 479
b@2042 480 % BRECHT: scripts
b@2042 481
b@1543 482 \begin{figure}[htpb]
b@1545 483 \centering
b@1545 484 \includegraphics[width=.45\textwidth]{boxplot.png}
b@1543 485 \caption{An example boxplot showing ratings by different subjects on fragments labeled `A' through `G'. }
b@1543 486 \label{fig:boxplot}
b@1543 487 \end{figure}
b@1543 488
b@1545 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.
b@1547 490 Visualisation of plots requires the free matplotlib library\footnote{http://matplotlib.org}.
b@2042 491
b@1987 492
b@1984 493 \section{Conclusions and future work}\label{sec:conclusions}
b@1984 494
b@1984 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.
b@1984 496 Specifically, we discussed the use of the toolbox in the context of assessment of preference for different production practices, with identical source material.
b@1999 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.
b@1984 498
b@1984 499 % future work
b@1543 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.
b@1987 501 In addition, we will keep on improving and expanding the tool, and highly welcome feedback and contributions from the community.
b@1984 502
b@1996 503 The source code of this tool can be found on \\ \texttt{code.soundsoftware.ac.uk/projects/}\\ \texttt{webaudioevaluationtool}.
b@1984 504
b@1984 505
b@1984 506 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
b@1984 507 %bibliography here
b@1984 508 \bibliography{smc2015template}
b@1984 509
b@1984 510 \end{document}