annotate docs/SMC15/smc2015template.tex @ 874:2ecb68305877

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