Headphone test

configs/complete.yaml

@@ -284,6 +284,20 @@ pages:
             label: Male
           - value: other
             label: Other
+       - type: dropdown
+         name: referral
+         label: How have you heard of us?
+         response:
+           - value: searchEngine
+             label: Google/internet search
+           - value: friends
+             label: Friends or colleagues
+           - value: participant
+             label: Previous experiment
+           - value: paper
+             label: Seen in published paper
+           - value: other
+             label: Other             
        - type: long_text
          label: Feedback
          name: feedback

configs/headphones_screen.yaml

@@ -0,0 +1,53 @@
+testname: webMUSHRA Example
+testId: headphones_screen_example
+bufferSize: 2048
+stopOnErrors: true
+showButtonPreviousPage: true
+remoteService: service/write.php
+
+
+pages:
+    - type: generic
+      id: first_page
+      name: Welcome
+      content: Welcome to webMUSHRA!       
+    - type: volume
+      id: vol
+      name: Volume settings
+      content: Please adjust the volume to a comfortable level.
+      stimulus: configs/resources/audio/stimuli_HugginsPitch/HugginsPitch_calibration.wav
+      defaultVolume: 0.5
+    - type: headphones_screen
+      id: hp_check
+      name: Headphones check
+      repetitions: 6
+      target: configs/resources/audio/stimuli_HugginsPitch/HugginsPitch_1.wav
+      other: 
+        A: configs/resources/audio/stimuli_HugginsPitch/HugginsPitch_2.wav
+        B: configs/resources/audio/stimuli_HugginsPitch/HugginsPitch_3.wav
+    - type: finish
+      name: Thank you
+      content: Thank you for attending!
+      showResults: true
+      writeResults: true
+      generateSubjectId: true
+      questionnaire:
+          - type: text
+            label: eMail
+            name: email
+          - type: number
+            label: Age
+            name: age
+            min: 0
+            max: 100
+            default: 30
+          - type: likert
+            name: gender
+            label: Gender
+            response:
+             - value: female
+               label: Female
+             - value: male
+               label: Male
+             - value: other
+               label: Other

configs/pref.yaml

@@ -0,0 +1,30 @@
+# test config preference test
+
+
+testname: Preference test
+testId: pref
+bufferSize: 2048
+stopOnErrors: true
+showButtonPreviousPage: true
+remoteService: service/write.php
+
+pages:
+    - type: preference_test
+      id: trialpref
+      name: Preference test
+      content: |
+        <p><b>Which sound do you prefer?</b></p>
+      considerOrder: true
+      mustPlayback: ended
+      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
+      generateSubjectId: true
+      confirmationCode: your_code_here

configs/pref_grouped.yaml

@@ -0,0 +1,28 @@
+# test config preference test
+
+
+testname: Preference test
+testId: pref_grouped
+bufferSize: 2048
+stopOnErrors: true
+showButtonPreviousPage: true
+remoteService: service/write.php
+
+pages:
+    - type: preference_test
+      id: trialpref
+      name: Preference test
+      content: |
+        <p><b>Which sound do you prefer?</b></p>
+      considerOrder: true
+      stimuli:
+          - C1: configs/resources/audio/mono_c1.wav
+            C2: configs/resources/audio/mono_c2.wav
+          - C3: configs/resources/audio/mono_c3.wav
+            C2: configs/resources/audio/mono_c2.wav
+
+    - type: finish
+      name: Thank you
+      content: Thank you for attending
+      showResults: true
+      writeResults: true

doc/experimenter.md

@@ -48,6 +48,21 @@ The volume page can be used to set the volume used in the experiment.
 * **stimulus** Filepath to the stimulus that is used for setting the volume.
 * **defaultVolume** Default volume (must be between 0.0 and 1.0).
 
+
+#### `headphones_screen` page
+
+This page can be used to perform a headphones screening. Sample files to conduct a test according to [Milne A, Bianco R, Poole K, Zhao S, Oxenham A, Billig A & Chait M. (2020) An online headphone screening test based on dichotic pitch. Behavior Research Methods.](https://rdcu.be/cbWrX) are provided, but the page can be used for any test following the same basic paradigm of identifying a target stimulus among a list of decoy stimuli.
+
+**Important:** There is currently no automated pass/fail arbitration so even subject failing to identify any of the targets will be allowed to complete the rest of the experiment. You can, however, use the results of the screening to filter your experiment results post-hoc.
+
+* **type** must be headphones_screen
+* **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.
+* **repetitions** Determines how many randomized repetitions of the task need to be completed.
+* **target** Filepath to the target stimulus to be identified.
+* **other** A map of stimuli to use as decoys. The key is the name of the decoy. The value is the filepath to the stimulus (WAV file).
+
 #### `mushra` page
 
 A mushra page shows a trial according to ITU-R Recommendation BS.1534.
@@ -96,6 +111,18 @@ A paired comparison page creates a forced or unforced paired comparison (AB/ABX/
 * **reference** Filepath to the reference stimulus (WAV file).
 * **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).  
 
+#### `preference_test` page
+
+A preference test page creates a forced paired comparison between two stimuli. The main difference to `paired_comparison` is that there is no reference or ground truth.
+
+* **type** must be preference_test.
+* **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.
+* **considerOrder** If set to true, a complete set of pairs is generated from the list of stimuli: A set of `{A, B}` would result in two pairs `(A, B)` and `(B, A)`. Otherwise only the pair `(A, B)` would be generated.
+* **mustPlayback** If set to `ended`, the participant must fully play back all stimuli to the end. If set to `processUpdate`, the participant must start playing back all stimuli before responding becomes possible.
+* **stimuli** Either a map of stimuli or an array of maps of stimuli. If it is a map, pairs will be generated from the list and then shuffled. If it is an array of maps, pairs will be generated for each map individually and then all the pairs from all maps are shuffled. 
+
 #### `likert_multi_stimulus` page
 
 A likert multi stimulus page creates a multi-stimulus likert rating.
@@ -133,6 +160,8 @@ The finish page must be the last page of the experiment.
 * **content** Content (HTML) of the page. The content is shown on the upper part of the page.
 * **showResults** The results are shown to the participant.  
 * **writeResults** The results are sent to the remote service (which writes the results into a file).
+* **generateSubjectId** If set to true, a random subject ID is generated and appended to the results.
+* **confirmationCode:** If set, this code is displayed after the results were sent. This can be used to confirm that subjects have completed the experiment and facilitates 
 
 
 ## Results

doc/participant.md

@@ -41,3 +41,8 @@
 * <kbd>SPACE</kbd> Play/pause the current selection
 * <kbd>a</kbd> Set begin of loop to current position
 * <kbd>b</kbd> Set end of loop to current position
+
+### Preference test
+
+* <kbd>1</kbd> Play item A
+* <kbd>2</kbd> Play item B

index.html

@@ -80,6 +80,8 @@
     <script src="lib/webmushra/datamodel/LikertSingleStimulusRating.js"></script>
     <script src="lib/webmushra/datamodel/PairedComparisonChoice.js"></script>
     <script src="lib/webmushra/datamodel/Participant.js"></script>
+    <script src="lib/webmushra/datamodel/PreferenceTestChoice.js"></script>
+    <script src="lib/webmushra/datamodel/HeadphonesScreenResponse.js"></script>
     <script src="lib/webmushra/datamodel/Session.js"></script>
     <script src="lib/webmushra/datamodel/Stimulus.js"></script>
     <script src="lib/webmushra/datamodel/Trial.js"></script>
@@ -108,9 +110,13 @@
     <script src="lib/webmushra/pages/BS1116PageManager.js"></script>
     <script src="lib/webmushra/pages/FinishPage.js"></script>
     <script src="lib/webmushra/pages/GenericPage.js"></script>
+    <script src="lib/webmushra/pages/HeadphonesScreenPage.js"></script>
+    <script src="lib/webmushra/pages/HeadphonesScreenPageManager.js"></script>
     <script src="lib/webmushra/pages/MushraPage.js"></script>
     <script src="lib/webmushra/pages/PairedComparisonPage.js"></script>
     <script src="lib/webmushra/pages/PairedComparisonPageManager.js"></script>
+    <script src="lib/webmushra/pages/PreferenceTestPage.js"></script>
+    <script src="lib/webmushra/pages/PreferenceTestPageManager.js"></script>
     <script src="lib/webmushra/pages/VolumePage.js"></script>
     <script src="lib/webmushra/pages/LikertSingleStimulusPage.js"></script>
     <script src="lib/webmushra/pages/LikertSingleStimulusPageManager.js"></script>

lib/webmushra/datamodel/HeadphonesScreenResponse.js

@@ -0,0 +1,12 @@
+/*************************************************************************
+         (C) Copyright AudioLabs 2017 
+
+This source code is protected by copyright law and international treaties. This source code is made available to You subject to the terms and conditions of the Software License for the webMUSHRA.js Software. Said terms and conditions have been made available to You prior to Your download of this source code. By downloading this source code You agree to be bound by the above mentionend terms and conditions, which can also be found here: https://www.audiolabs-erlangen.de/resources/webMUSHRA. Any unauthorised use of this source code may result in severe civil and criminal penalties, and will be prosecuted to the maximum extent possible under law. 
+
+**************************************************************************/
+
+function HeadphonesScreenResponse() {
+  this.correct = null;
+  this.comment = null;
+  this.time = null;
+}

lib/webmushra/datamodel/PreferenceTestChoice.js

@@ -0,0 +1,14 @@
+/*************************************************************************
+         (C) Copyright AudioLabs 2017 
+
+This source code is protected by copyright law and international treaties. This source code is made available to You subject to the terms and conditions of the Software License for the webMUSHRA.js Software. Said terms and conditions have been made available to You prior to Your download of this source code. By downloading this source code You agree to be bound by the above mentionend terms and conditions, which can also be found here: https://www.audiolabs-erlangen.de/resources/webMUSHRA. Any unauthorised use of this source code may result in severe civil and criminal penalties, and will be prosecuted to the maximum extent possible under law. 
+
+**************************************************************************/
+
+function PreferenceTestChoice() {
+  this.optionA = null;
+  this.optionB = null;
+  this.answer = null;
+  this.comment = null;
+  this.time = null;
+}

lib/webmushra/nls/nls.js

@@ -76,6 +76,10 @@ nls['fr']['slightly'] = "Légèrement gênante";
 nls['fr']['annoying'] = "Dégradation gênante";
 nls['fr']['very'] = "Dégradation très gênante";
 
+// captions Preference Test
+nls['en']['pref'] = "Which item do you prefer?";
+nls['de']['pref'] = "Welche Version bevorzugen Sie?";
+nls['fr']['pref'] = "Quel item préférez-vous?";
 
 
 // captions Paired Comparison AB/ABN
@@ -90,3 +94,9 @@ nls['fr']['results'] = "Vos résultats:";
 nls['en']['attending'] = "Thank you for your participation!";
 nls['de']['attending'] = "Vielen Dank für die Teilnahme!";
 nls['fr']['attending'] = "Merci pour votre participation!";
+nls['en']['response'] = "Response";
+nls['de']['response'] = "Antwort";
+nls['fr']['response'] = "Réponse";
+nls['en']['code'] = "Your confirmation code:";
+nls['de']['code'] = "Ihr Bestätigungscode:";
+nls['fr']['code'] = "Votre code de confirmation:";