annotate docs/SMC15/smc2015template.tex @ 1103:2051868b21f0

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