Added ranking by elimination test

README.md

@@ -31,6 +31,7 @@ We provide two version of webMUSHRA.
   * MUSHRA (ITU-R BS.1534)
   * AB (ITU-R BS.1116)
   * Likert scale questionaires
+  * Ranking by elimination
   * training/introduction
   * spatial attributes, such as ASW, LEV, and localization (experimental)
 * compliant to ITU recommendations (looping, fade-in/out, sample accurate switching)

configs/ranking_noloop.yaml

@@ -0,0 +1,62 @@
+# test config ranking page, waveform, 11 conditions, no looping
+
+
+testname: Rank order Elimination-by-Aspects
+testId: ranking_noloop
+bufferSize: 2048
+stopOnErrors: true
+showButtonPreviousPage: true
+remoteService: service/write.php
+
+
+pages:
+    - type: generic
+      id: first_page
+      name: Welcome
+      content: <p style="text-align:left;"> Welcome to the rank order elimination-by-aspects test. <br> The goal of this test is to rank the presented conditions on personal preference of quality. <br> The test is conducted as described below: <br>[1] Listen to all the conditions one after the other using the "Play" button. <br> [2] Eliminate the worst condition using the "X" button below it. <br> [3] Repeat steps [1] and [2] until you are left with one condition or if you don't have a preference over remaining conditions.<br> [4]  You can reset the rankings by pressing "Reset" at any time, and all rankings done till that point will be reset.<br> [5] Proceed to the next test using "next" button. <br><br> NOTE.1: You can only eliminate an "active" condition, i.e. a condition whose button is currently higlighted. <br>  NOTE.2:  You cannot play again an already eliminated condition. ("Reset" re-enables all conditions). <br> NOTE.3: Once a condition is eliminated, its rank will appear on its button. Lower rank (1-5) indicate worse quality. So the worst condition will have rank 1, the second worst 2, ... <br> NOTE.4: If you press the "previous" button, the rankings of the previous test are lost and you can repeat the previous test. </p>
+
+    - type: ranking
+      id: trial1
+      name: Mono Trial
+      content: test description
+      showWaveform: false
+      enableLooping: false
+      randomize: true
+      showConditionNames: true
+      showResetButton: true
+      stimuli:
+          C1: configs/resources/audio/mono_c1.wav
+          C2: configs/resources/audio/mono_c2.wav
+          C3: configs/resources/audio/mono_c3.wav
+
+    - type: ranking
+      id: trial2
+      name: Mono Trial
+      content: test description
+      showWaveform: false
+      enableLooping: false
+      randomize: true
+      showConditionNames: true
+      showResetButton: true
+
+      stimuli:
+          C1: configs/resources/audio/mono_c1.wav
+          C2: configs/resources/audio/mono_c2.wav
+          C3: configs/resources/audio/mono_c3.wav
+
+    - type: finish
+      name: Thank you
+      content: Thank you for attending!
+      showResults: true
+      writeResults: true
+      questionnaire:
+          - type: text
+            label: Nickname
+            name: id
+          - type: number
+            label: Age
+
+            name: age
+            min: 0
+            max: 100
+            default: 30

doc/experimenter.md

@@ -76,6 +76,22 @@ A mushra page shows a trial according to ITU-R Recommendation BS.1534.
 * **stimuli** A map of stimuli representing three conditions. The key is the name of the condition. The value is the filepath to the stimulus (WAV file).  
 * **switchBack** If set to true, the time position is set back to the beginning (sample 0) when switching between test conditions and/or the reference. By default, this option is false.
 
+#### `ranking` page
+
+A ranking-by-elimination test trial page
+
+* **type** must be ranking.
+* **id** Identifier of the page.
+* **name** Name of the page (is shown as title)
+* **content** Content (HTML) of the page. The content is shown on the upper part of the page.
+* **showWaveform** If set to true, the waveform of the reference is shown.
+* **enableLooping** If set to true, the participant can set loops.
+* **randomize** If set to true, the conditions are randomized.
+* **showConditionNames** If set to true, the names of the conditions are shown.
+* **stimuli** A map of stimuli representing three conditions. The key is the name of the condition. The value is the filepath to the stimulus (WAV file).  
+* **switchBack** If set to true, the time position is set back to the beginning (sample 0) when switching between test conditions and/or the reference. By default, this option is false.
+* **forceRankAll** If set to true, the "next" button will only be enabled if all items are ranked.
+
 #### `bs1116` page          
 
 A bs1116 page shows a trial according to ITU-R Recommendation BS.1116.

index.html

@@ -111,6 +111,7 @@
     <script src="lib/webmushra/pages/GenericPage.js"></script>
     <script src="lib/webmushra/pages/ConsentPage.js"></script>
     <script src="lib/webmushra/pages/MushraPage.js"></script>
+    <script src="lib/webmushra/pages/RankingPage.js"></script>
     <script src="lib/webmushra/pages/PairedComparisonPage.js"></script>
     <script src="lib/webmushra/pages/PairedComparisonPageManager.js"></script>
     <script src="lib/webmushra/pages/VolumePage.js"></script>

lib/webmushra/nls/nls.js

@@ -8,20 +8,26 @@ nls['en']['previousButton'] = "Previous";
 nls['en']['playButton'] = "Play";
 nls['en']['stopButton'] = "Stop"; 
 nls['en']['pauseButton'] = "Pause";
+nls['en']['eliminateButton'] = "X";
+nls['en']['resetButton'] = "Reset";
 nls['en']['sendButton'] = "Send Results";
 
 nls['de']['nextButton'] = "Nächste Seite";
 nls['de']['previousButton'] = "Vorherige Seite"; 
 nls['de']['playButton'] = "Start";
 nls['de']['stopButton'] = "Stopp"; 
 nls['de']['pauseButton'] = "Pause";
+nls['de']['eliminateButton'] = "X";
+nls['de']['resetButton'] = "Reset";
 nls['de']['sendButton'] = "Ergebnisse senden";
 
 nls['fr']['nextButton'] = "Suivant";
 nls['fr']['previousButton'] = "Précédent";
 nls['fr']['playButton'] = "Play";
 nls['fr']['stopButton'] = "Stop";
 nls['fr']['pauseButton'] = "Pause";
+nls['fr']['eliminateButton'] = "X";
+nls['fr']['resetButton'] = "Reset";
 nls['fr']['sendButton'] = "Envoyer les résultats";
 
 // captions MUSHRA