# HG changeset patch # User Brecht De Man # Date 1460193989 -3600 # Node ID b332dcc65b8c85f70aff142ca156481bde3aa546 # Parent 41577a11f12ee01ce175e75776df5402c0139b71 Instructions update (folder contents); moved legacy analysis page to analysis folder; removed README.txt in favour of markdown diff -r 41577a11f12e -r b332dcc65b8c README.txt --- a/README.txt Fri Apr 08 12:25:05 2016 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -WEB AUDIO EVALUATION TOOL - -AUTHORS - -Nicholas Jillings -Brecht De Man -David Moffat -Joshua D. Reiss (supervisor) -Ryan Stables (supervisor) - - -INSTRUCTIONS FOR USE - -Please refer to 'docs/Instructions/Instructions.pdf'. - - -ACADEMIC USE - -Please refer to CITING.txt. - - -OTHER USE - -Please refer to LICENSE.txt (GNU GENERAL PUBLIC LICENSE). \ No newline at end of file diff -r 41577a11f12e -r b332dcc65b8c analyse.html --- a/analyse.html Fri Apr 08 12:25:05 2016 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,751 +0,0 @@ - - - - - - - - - Analysis - - - - - - - - - - - - - -

Subjective evaluation results

- -
- XML file folder: -
- -
-
- Result XML files: -
-
- Audioholders in dataset: -
-
- Subjects in dataset: -
-
- Audioelements in dataset: -
-
-
-
- - - - - diff -r 41577a11f12e -r b332dcc65b8c analysis/analyse.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/analysis/analyse.html Sat Apr 09 10:26:29 2016 +0100 @@ -0,0 +1,751 @@ + + + + + + + + + Analysis + + + + + + + + + + + + + +

Subjective evaluation results

+ +
+ XML file folder: +
+ +
+
+ Result XML files: +
+
+ Audioholders in dataset: +
+
+ Subjects in dataset: +
+
+ Audioelements in dataset: +
+
+
+
+ + + + + diff -r 41577a11f12e -r b332dcc65b8c docs/Instructions/Instructions.pdf Binary file docs/Instructions/Instructions.pdf has changed diff -r 41577a11f12e -r b332dcc65b8c docs/Instructions/Instructions.tex --- a/docs/Instructions/Instructions.tex Fri Apr 08 12:25:05 2016 +0100 +++ b/docs/Instructions/Instructions.tex Sat Apr 09 10:26:29 2016 +0100 @@ -48,25 +48,41 @@ \textbf{Main folder:} \begin{itemize} - \item \texttt{analyse.html}: analysis and diagnostics of a set of result XML files \item \texttt{core.css, graphics.css, structure.css}: core style files (edit to change appearance) - \item \texttt{CITING.txt, LICENSE.txt, README.txt}: text files with, respectively, the citation which we ask to include in any work where this tool or any portion thereof is used, modified or otherwise; the license under which the software is shared; and a general readme file referring to these instructions. + \item \texttt{CITING.txt, LICENSE.txt, README.md}: text files with, respectively, the citation which we ask to include in any work where this tool or any portion thereof is used, modified or otherwise; the license under which the software is shared; and a general readme file. \item \texttt{core.js}: JavaScript file with core functionality - \item \texttt{index.html}: webpage where interface should appear (includes link to test configuration XML) + \item \texttt{demo.html}: Several demonstrations of listening tests, using examples from the example\_eval folder + \item \texttt{index.html}: webpage where interface should appear (append link to configuration XML, e.g. index.html?url=config.xml) \item \texttt{jquery-2.1.4.js}: jQuery JavaScript Library + \item \texttt{keygen.php}: generates a unique file name for saved results \item \texttt{loudness.js}: Allows for automatic calculation of loudness of Web Audio API Buffer objects, return gain values to correct for a target loudness or match loudness between multiple objects + \item \texttt{pseudo.php}: allows for pseudo-random selection from a range of configuration XML files \item \texttt{pythonServer.py}: webserver for running tests locally \item \texttt{pythonServer-legacy.py}: webserver with limited functionality (no automatic storing of output XML files) - \item \texttt{save.php}: PHP script to store result XML files to web server\\ + \item \texttt{save.php}: PHP script to store result XML files to web server + \item \texttt{scaledefinitions.xml}: marker text and positions for various scales + \item \texttt{specification.js}: decodes configuration XML to JavaScript object + \item \texttt{test-schema.xsd}: definition of configuration and result XML file structure + \item \texttt{WAVE.js}: decodes and performs WAVE file byte level manipulation + \item \texttt{xmllint.js}: XML validation\\ + \end{itemize} + \textbf{Analysis of results (./analysis/)} + \begin{itemize} + \item \texttt{analyse.html}: analysis and diagnostics of a set of result XML files (legacy) + \item \texttt{analysis.css}: analysis page style file + \item \texttt{analysis.js}: analysis functions + \item \texttt{index.html}: web page where analysis of stored results can be performed \end{itemize} \textbf{Documentation (./docs/)} \begin{itemize} + \item AESPosterComp: PDF and \LaTeX source of Audio Engineering Society UK Sustaining Members event at Solid State Logic, Begbroke \item \href{http://c4dm.eecs.qmul.ac.uk/dmrn/events/dmrnp10/#posters}{DMRN+10}: PDF and \LaTeX source of poster for 10\textsuperscript{th} Digital Music Research Network One-Day workshop (``soft launch'') \item Instructions: PDF and \LaTeX source of these instructions \item Project Specification Document (\LaTeX/PDF) \item Results Specification Document (\LaTeX/PDF) \item SMC15: PDF and \LaTeX source of 12th Sound and Music Computing Conference paper \cite{waet} - \item WAC2016: PDF and \LaTeX source of 2nd Web Audio Conference paper\\ + \item WAC2016: PDF and \LaTeX source of 2nd Web Audio Conference paper \cite{waetwac} + \item WAC2016Poster: PDF and \LaTeX source of 2nd Web Audio Conference poster\\ \end{itemize} \textbf{Example project (./example\_eval/)} \begin{itemize} @@ -76,14 +92,13 @@ \begin{itemize} \item Each interface class has a JavaScript file and an optional CSS style file. These are loaded as needed. \end{itemize} - \textbf{Output files (./saves/)} \begin{itemize} \item The output XML files of tests will be stored here by default by the \texttt{pythonServer.py} script.\\ \end{itemize} \textbf{Auxiliary scripts (./scripts/)} \begin{itemize} - \item Helpful Python scripts for extraction and visualisation of data.\\ + \item Helpful Python and PHP scripts for extraction and visualisation of data.\\ \end{itemize} \textbf{Test creation tool (./test\_create/)} \begin{itemize}