Skip to content

Commit 6cb78f4

Browse files
bendichterbendichter
committed
Add behavioral audio/video recordings example dataset
1 parent 9d11438 commit 6cb78f4

27 files changed

Lines changed: 312 additions & 0 deletions

‎beh_audio_video_recordings/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Behavioral audio/video recordings
2+
3+
This dataset provides a minimal example of behavioral **audio** and **video** recordings stored in the `beh/` directory, as proposed in bids-standard/bids-specification PR #2231.
4+
5+
Note: media files are small placeholder files for example purposes.
6+
7+
## Contents
8+
9+
- `sub-01/beh/`: speech audio + rest video + events
10+
- `sub-02/beh/`: stroop multi-camera video + vocalization audio runs + events
11+
12+
## Validation
13+
14+
When validated with a schema that includes the PR #2231 rules, this dataset should produce no errors (warnings for recommended metadata keys may remain).

‎beh_audio_video_recordings/README.source.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Audio and Video Behavioral Recordings Example Dataset
2+
3+
This is an example BIDS dataset demonstrating the new audio and video recording features for behavioral experiments as specified in [PR #2231](https://github.com/bids-standard/bids-specification/pull/2231).
4+
5+
## Dataset Description
6+
7+
This dataset contains behavioral audio and video recordings from 2 participants performing various tasks:
8+
9+
### Subject 01
10+
- **Speech task**: Audio recording of participant describing a picture (WAV format)
11+
- **Resting state**: Video recording of participant sitting comfortably (MP4 format)
12+
13+
### Subject 02
14+
- **Stroop task**: Multiple simultaneous video recordings from different angles (face close-up and room view)
15+
- **Vocalization task**: Two runs of audio recordings in FLAC format
16+
17+
## Key Features Demonstrated
18+
19+
1. **Audio file formats**: WAV and FLAC
20+
2. **Video file formats**: MP4
21+
3. **Multiple recording angles**: Using the `recording` entity to distinguish simultaneous recordings
22+
4. **Multiple runs**: Using the `run` entity for repeated tasks
23+
5. **Metadata**: JSON sidecar files with device information, audio/video technical specifications
24+
6. **Events files**: Annotations for the speech task with timing information
25+
7. **Timing alignment**: `scans.tsv` files for synchronization across recordings
26+
27+
## File Structure
28+
29+
```
30+
bids-audio-video-example/
31+
├── dataset_description.json
32+
├── participants.tsv
33+
├── participants.json
34+
├── README.md
35+
├── sub-01/
36+
│ ├── sub-01_scans.tsv
37+
│ ├── sub-01_scans.json
38+
│ └── beh/
39+
│ ├── sub-01_task-speech_audio.wav
40+
│ ├── sub-01_task-speech_audio.json
41+
│ ├── sub-01_task-speech_events.tsv
42+
│ ├── sub-01_task-speech_events.json
43+
│ ├── sub-01_task-rest_video.mp4
44+
│ └── sub-01_task-rest_video.json
45+
└── sub-02/
46+
├── sub-02_scans.tsv
47+
├── sub-02_scans.json
48+
└── beh/
49+
├── sub-02_task-stroop_recording-face_video.mp4
50+
├── sub-02_task-stroop_recording-face_video.json
51+
├── sub-02_task-stroop_recording-room_video.mp4
52+
├── sub-02_task-stroop_recording-room_video.json
53+
├── sub-02_task-vocalization_run-01_audio.flac
54+
├── sub-02_task-vocalization_run-01_audio.json
55+
├── sub-02_task-vocalization_run-02_audio.flac
56+
└── sub-02_task-vocalization_run-02_audio.json
57+
```
58+
59+
## Note on Placeholder Files
60+
61+
The audio and video files in this example dataset are placeholder files (empty or minimal content) for demonstration purposes. In a real dataset, these would be actual media files containing the recorded data.
62+
63+
## Privacy Considerations
64+
65+
When working with real audio and video recordings of human subjects, ensure compliance with applicable privacy regulations (HIPAA, GDPR, etc.) as these files often contain personally identifiable information.

‎beh_audio_video_recordings/dataset_description.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"Name": "Audio and Video Behavioral Recordings Example",
3+
"BIDSVersion": "1.10.0",
4+
"DatasetType": "raw",
5+
"License": "CC0",
6+
"Authors": ["BIDS Example Team", "BIDS Community Contributors"],
7+
"Acknowledgements": "This is an example dataset for demonstrating audio and video recordings in BIDS",
8+
"ReferencesAndLinks": [
9+
"https://github.com/bids-standard/bids-specification/pull/2231"
10+
],
11+
"DatasetDOI": "10.0000/example.audio-video"
12+
}

‎beh_audio_video_recordings/participants.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"participant_id": {
3+
"Description": "Unique participant identifier"
4+
},
5+
"age": {
6+
"Description": "Age of the participant",
7+
"Units": "years"
8+
},
9+
"sex": {
10+
"Description": "Sex of the participant",
11+
"Levels": {
12+
"M": "Male",
13+
"F": "Female"
14+
}
15+
},
16+
"handedness": {
17+
"Description": "Handedness of the participant",
18+
"Levels": {
19+
"left": "Left-handed",
20+
"right": "Right-handed",
21+
"ambidextrous": "Ambidextrous"
22+
}
23+
}
24+
}

‎beh_audio_video_recordings/participants.tsv‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
participant_id age sex handedness
2+
sub-01 25 F right
3+
sub-02 30 M left

‎beh_audio_video_recordings/sub-01/beh/sub-01_task-rest_video.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"TaskName": "RestingState",
3+
"TaskDescription": "Participant sitting comfortably with eyes open for 10 minutes",
4+
"Device": "Sony FDR-AX53",
5+
"DeviceSerialNumber": "AX53-789012",
6+
"AudioChannelCount": 2,
7+
"AudioSampleRate": 48000,
8+
"FrameRate": 30.0,
9+
"CameraPosition": "front",
10+
"Height": 1080,
11+
"Width": 1920,
12+
"Duration": 600.5
13+
}

‎beh_audio_video_recordings/sub-01/beh/sub-01_task-rest_video.mp4‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
placeholder

‎beh_audio_video_recordings/sub-01/beh/sub-01_task-speech_audio.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"TaskName": "Speech",
3+
"TaskDescription": "Participant was asked to describe a picture for 2 minutes",
4+
"Device": "Zoom H6 Handy Recorder",
5+
"DeviceSerialNumber": "H6-123456",
6+
"AudioChannelCount": 2,
7+
"AudioSampleRate": 44100,
8+
"AudioBitDepth": 16,
9+
"Duration": 120.5
10+
}

‎beh_audio_video_recordings/sub-01/beh/sub-01_task-speech_audio.wav‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
placeholder

‎beh_audio_video_recordings/sub-01/beh/sub-01_task-speech_events.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"TaskName": "Speech",
3+
"TaskDescription": "Participant was asked to describe a picture for 2 minutes",
4+
"event_type": {
5+
"Description": "Type of event",
6+
"Levels": {
7+
"task": "Overall task period",
8+
"vocalization": "Participant speaking or vocalizing",
9+
"pause": "Pause in speech",
10+
"cough": "Non-speech vocalization"
11+
}
12+
},
13+
"description": {
14+
"Description": "Detailed description of the event"
15+
}
16+
}

0 commit comments

Comments
 (0)