annotate docs/SMC15/smc2015template.tex @ 767:d7f2912bf487

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