annotate docs/SMC15/smc2015template.tex @ 1486:c6d5f521ff90

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