annotate docs/SMC15/smc2015template.tex @ 765:e66434e0f573

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