├── .editorconfig ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── DATASET_SCHEMA.md ├── LICENSE └── README.md /.editorconfig: -------------------------------------------------------------------------------- 1 | # 2 | # For licensing see accompanying LICENSE file. 3 | # Copyright (C) 2022 Apple Inc. All Rights Reserved. 4 | # 5 | # http://editorconfig.org 6 | 7 | # top-most EditorConfig file 8 | root = true 9 | 10 | # Default Configuration for most files 11 | [*] 12 | indent_style = space 13 | indent_size = 4 14 | trim_trailing_whitespace = true 15 | insert_final_newline = true 16 | charset = utf-8 17 | end_of_line = lf 18 | max_line_length = 100 19 | 20 | [Makefile] 21 | indent_style = tab 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | venv/ 2 | .venv/ 3 | .DS_Store 4 | __pycache__/ 5 | .idea/ 6 | .pytest_cache/ 7 | .mypy_cache/ 8 | doc/_build 9 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies within all project spaces, and it also applies when 49 | an individual is representing the project or its community in public spaces. 50 | Examples of representing a project or community include using an official 51 | project e-mail address, posting via an official social media account, or acting 52 | as an appointed representative at an online or offline event. Representation of 53 | a project may be further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the open source team at [opensource-conduct@group.apple.com](mailto:opensource-conduct@group.apple.com). All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, 71 | available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guide 2 | 3 | Thanks for your interest in contributing. This project was released to accompany a research paper for purposes of reproducability, and beyond its publication there are limited plans for future development of the repository. 4 | 5 | While we welcome new pull requests and issues please note that our response may be limited. Forks and out-of-tree improvements are strongly encouraged. 6 | 7 | ## Before you get started 8 | 9 | By submitting a pull request, you represent that you have the right to license your contribution to Apple and the community, and agree by submitting the patch that your contributions are licensed under the [LICENSE](LICENSE). 10 | 11 | We ask that all community members read and observe our [Code of Conduct](CODE_OF_CONDUCT.md). 12 | -------------------------------------------------------------------------------- /DATASET_SCHEMA.md: -------------------------------------------------------------------------------- 1 | Spatial LibriSpeech Schema 2 | ========================== 3 | 4 | This document describes the metadata schema for Spatial LibriSpeech. The metadata is organised as 5 | columns of a pandas' DataFrame. We first describe how to load the dataframe, and then list all its 6 | columns. 7 | 8 | ### Loading the metadata 9 | 10 | Once you have downloaded any the dataset you can load the dataset with the following command: 11 | 12 | ```python3 13 | import pandas as pd 14 | metadata = pd.read_parquet("/metadata.parquet") 15 | ``` 16 | 17 | Alternatively, you can download the metadata directly from the internet: 18 | 19 | ```python3 20 | import pandas as pd 21 | metadata = pd.read_parquet("https://docs-assets.developer.apple.com/ml-research/datasets/spatial-librispeech/v1/metadata.parquet") 22 | ``` 23 | 24 | The rest of this document describes the metadata schema for Spatial LibriSpeech (organised by 25 | columns in the dataframe) 26 | 27 | 28 | ## Sample identification metadata 29 | 30 | - `sample_id` 31 | * Type: `int` 32 | * Range: [0, 22] 33 | * Dataloader feature: `spatial_librispeech.Feature.SAMPLE_ID` 34 | * Numeric identifier for sample. Corresponding audio files will be named `{sample_id:06}.flac`. 35 | 36 | - `split` 37 | * Type: `string` 38 | * Values: [`train`, `test`] 39 | * Determines whether current sample belongs to the train or the test set. 40 | 41 | - `lite_version` 42 | * Type: `boolean` 43 | * If true, current sample is part of the lite version of the dataset. 44 | 45 | 46 | ## Acoustics metadata 47 | - `acoustics/frequency_bins` 48 | * Type: `numpy.array` of 33 `floats` 49 | * Unit: hertz 50 | * Dataloader feature: `spatial_librispeech.Feature.FREQUENCY_BINS` 51 | * Mean frequency values of the third octave bins used for all acoustic features. 52 | 53 | - `acoustics/c50_db` 54 | * Type: `numpy.array` of 33 `floats` 55 | * Unit: decibels 56 | * Dataloader feature: `spatial_librispeech.Feature.C50_DB` 57 | * Third octave values of speech clarity (C50) in decibels. 58 | 59 | - `acoustics/drr_db` 60 | * Type: `numpy.array` of 33 `floats` 61 | * Unit: decibels 62 | * Dataloader feature: `spatial_librispeech.Feature.DRR_DB` 63 | * Third octave values of direct-to-reverberant-ratio (DRR) in decibels. 64 | 65 | - `acoustics/edt_ms` 66 | * Type: `numpy.array` of 33 `floats` 67 | * Unit: milliseconds 68 | * Dataloader feature: `spatial_librispeech.Feature.EDT_MS` 69 | * Third octave values of early-decay time (EDT) in milliseconds. 70 | 71 | - `acoustics/t20_ms` 72 | * Type: `numpy.array` of 33 `floats` 73 | * Unit: milliseconds 74 | * Dataloader feature: `spatial_librispeech.Feature.T20_MS` 75 | * Third octave values of 20dB decay duration (T20) in milliseconds. 76 | 77 | - `acoustics/t30_ms` 78 | * Type: `numpy.array` of 33 `floats` 79 | * Unit: milliseconds 80 | * Dataloader feature: `spatial_librispeech.Feature.T30_MS` 81 | * Third octave values of 30dB decay duration (T30) in milliseconds. 82 | 83 | 84 | ## Audio information 85 | 86 | - `audio_info/duration` 87 | * Type: `float` 88 | * Unit: seconds 89 | * Sample duration in seconds. 90 | 91 | - `audio_info/frames` 92 | * Type: `int` 93 | * Unit: seconds 94 | * Number of frames in audio sample. Note sample rate is 16kHz. 95 | 96 | - `audio_info/size/ambisonics` 97 | * Type: `int` 98 | * Unit: bytes 99 | * Size of speech ambisonics sample in bytes. 100 | 101 | - `audio_info/size/noise_ambisonics` 102 | * Type: `int` 103 | * Unit: bytes 104 | * Size of distractor noise ambisonics sample in bytes. 105 | 106 | - `audio_info/checksum/ambisonics` 107 | * Type: `string` 108 | * Hexadecimal representation of sha-256 checksum of speech ambisonics sample. 109 | 110 | - `audio_info/checksum/noise_ambisonics` 111 | * Type: `string` 112 | * Hexadecimal representation of sha-256 checksum of distractor noise ambisonics sample. 113 | 114 | 115 | ## Speech metadata 116 | 117 | - `speech/azimuth` 118 | * Type: `float` 119 | * Unit: radians 120 | * Dataloader feature: `spatial_librispeech.Feature.AZIMUTH` 121 | * Horizontal angle between speech source and microphone array. 122 | 123 | - `speech/elevation` 124 | * Type: `float` 125 | * Unit: radians 126 | * Dataloader feature: `spatial_librispeech.Feature.ELEVATION` 127 | * Vertical angle between speech source and microphone array. 128 | 129 | - `speech/distance` 130 | * Type: `float` 131 | * Unit: meters 132 | * Dataloader feature: `spatial_librispeech.Feature.DISTANCE` 133 | * Distance between speech source and microphone array. 134 | 135 | - `speech/speaking_azimuth` 136 | * Type: `float` 137 | * Unit: radians 138 | * Dataloader feature: `spatial_librispeech.Feature.SPEAKING_AZIMUTH` 139 | * Horizontal rotation of speech source with respect to microphone array. Zero is in direct line of array. 140 | 141 | - `speech/speaking_elevation` 142 | * Type: `float` 143 | * Unit: radians 144 | * Dataloader feature: `spatial_librispeech.Feature.SPEAKING_ELEVATION` 145 | * Vertical rotation of speech source with respect to microphone array. Zero is in direct line of array. 146 | 147 | - `speech/mrp` 148 | * Type: `float` 149 | * Unit: decibels at random active speech level (dB-ASL) 150 | * Signal power for speech at mouth reference point (25 mm in front of the lip plane,cf. ITU-T P.58) 151 | 152 | - `speech/source_id` 153 | * Type: `float` 154 | * Range: [1, 20] 155 | * Numeric identifier for speech source location in the room. 156 | 157 | - `speech/directivity_id` 158 | * Type: `int` 159 | * Range: [0, 15] 160 | * Dataloader feature: `spatial_librispeech.Feature.DIRECTIVITY_ID` 161 | * Numeric identifier for the different directivity profiles applied to speech. 162 | 163 | 164 | ### Original LibriSpeech metadata 165 | 166 | - `speech/librispeech_metadata/book_id"` 167 | * Type: `int` 168 | * * Dataloader feature: `spatial_librispeech.Feature.BOOK_ID` 169 | * Numeric identifier for book being read. 170 | 171 | - `speech/librispeech_metadata/chapter_id"` 172 | * Type: `int` 173 | * Dataloader feature: `spatial_librispeech.Feature.CHAPTER_ID` 174 | * Numeric identifier for chapter being read. 175 | 176 | - `speech/librispeech_metadata/chapter_title"` 177 | * Type: `string` 178 | * Name of chapter being read. 179 | 180 | - `speech/librispeech_metadata/project_id"` 181 | * Type: `int` 182 | * Dataloader feature: `spatial_librispeech.Feature.PROJECT_ID` 183 | * Numeric identifier for project being read. 184 | 185 | - `speech/librispeech_metadata/project_title"` 186 | * Type: `string` 187 | * Name of project being read. 188 | 189 | - `speech/librispeech_metadata/reader_id"` 190 | * Type: `int` 191 | * Numeric identifier for reader. 192 | 193 | - `speech/librispeech_metadata/reader_name"` 194 | * Type: `string` 195 | * Name (or alias) of reader. 196 | 197 | - `speech/librispeech_metadata/reader_sex"` 198 | * Type: `string` 199 | * Dataloader feature: `spatial_librispeech.Feature.READER_SEX` 200 | * Values: [`m`, `f`] # TODO: verify these 201 | * Sex of reader. 202 | 203 | - `speech/librispeech_metadata/sequence_number"` 204 | * Type: `int` 205 | * Dataloader feature: `spatial_librispeech.Feature.SEQUENCE_NUMBER` 206 | * Sequence identifier for utterance (will be ordered for same project, book, and chapter). 207 | 208 | - `speech/librispeech_metadata/transcription"` 209 | * Type: `string` 210 | * Dataloader feature: `spatial_librispeech.Feature.TRANSCRIPTION` 211 | * Transcription of text being read. 212 | 213 | - `speech/librispeech_metadata/subset"` 214 | * Type: `string` 215 | * Values: [`train-clean-100`, `train-clean-360`, `test-clean`, `test-other`] 216 | * Original librispeech subset for utterance. 217 | 218 | ## Noise metadata 219 | 220 | - `noise/azimuth` 221 | * Type: `float` 222 | * Unit: radians 223 | * Dataloader feature: `spatial_librispeech.Feature.NOISE_AZIMUTH` 224 | * Horizontal angle between distractor noise source and microphone array. 225 | 226 | - `noise/elevation` 227 | * Type: `float` 228 | * Unit: radians 229 | * Dataloader feature: `spatial_librispeech.Feature.NOISE_ELEVATION` 230 | * Vertical angle between distractor noise source and microphone array. 231 | 232 | - `noise/distance` 233 | * Type: `float` 234 | * Unit: meters 235 | * Dataloader feature: `spatial_librispeech.Feature.NOISE_DISTANCE` 236 | * Distance between distractor noise source and microphone array. 237 | 238 | - `noise/snr` 239 | * Type: `float` 240 | * Unit: decibels 241 | * Dataloader feature: `spatial_librispeech.Feature.SNR_DB` 242 | * Signal-to-noise ratio for distractor noise in decibels. 243 | 244 | - `noise/source_id` 245 | * Type: `float` 246 | * Range: [1, 20] 247 | * Numeric identifier for distractor noise source location in the room. 248 | 249 | - `noise/deep_noise_suppression_metadata/filename` 250 | * Type: `string` 251 | * Filename of noise in deep noise suppression. 252 | 253 | - `noise/deep_noise_suppression_metadata/is_audioset` 254 | * Type: `boolean` 255 | * If true, noise is part of Audioset dataset, otherwise it is part of Freesound dataset. 256 | 257 | - `noise/deep_noise_suppression_metadata/is_audioset` 258 | * Type: `string` 259 | * Comma-separated labels for noise, for Audioset you may need to consult lookup table. 260 | 261 | - `noise/deep_noise_suppression_metadata/youtube_id` 262 | * Type: `string` 263 | * Only available for Audioset samples, youtube id of video from where noise was extracted. 264 | 265 | 266 | ## Room metadata 267 | 268 | - `room/room_id` 269 | * Type: `int` 270 | * Dataloader feature: `spatial_librispeech.Feature.ROOM_ID` 271 | * Numeric identifier for simulated simulated room. 272 | 273 | - `room/floor_area` 274 | * Type: `float` 275 | * Unit: squared meters 276 | * Room's floor surface area. 277 | 278 | - `room/surface_area` 279 | * Type: `float` 280 | * Unit: squared meters 281 | * Sum of the area of all surface (floor, walls, ceiling) in the room. 282 | 283 | - `room/volume` 284 | * Type: `float` 285 | * Unit: cubic meters 286 | * Room's total volume. 287 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (C) 2023, Apple Inc. 2 | 3 | The Spatial LibriSpeech dataset (“the Dataset”) uses the following 4 | datasets (“the Original Datasets”): 5 | 6 | * LibriSpeech ASR Corpus 7 | - Available at: https://www.openslr.org/12/ 8 | - License: https://creativecommons.org/licenses/by/4.0/ 9 | 10 | * Microsoft Deep Noise Suppression 11 | - Available at: https://github.com/microsoft/DNS-Challenge/ 12 | - Only the noise files from AudioSet and Freesound were selected 13 | - License: https://creativecommons.org/licenses/by/4.0/ 14 | 15 | * AudioSet 16 | - Available at: https://research.google.com/audioset/index.html 17 | - License: https://creativecommons.org/licenses/by/4.0/ 18 | 19 | * Freesound 20 | - Available at: https://freesound.org/ 21 | - Only files with CC0 licenses were selected 22 | - License: https://creativecommons.org/publicdomain/zero/1.0/ 23 | 24 | 25 | Apple’s copyrights in The Dataset are hereby licensed under the Creative-Commons 26 | Attribution 4.0 International License (CC BY 4.0). A human readable summary of 27 | the license is available here: https://creativecommons.org/licenses/by/4.0/ and 28 | the full text included below. Apple makes no representations with regards to the 29 | licenses of datasets that have been used to derive The Dataset, which remain 30 | subject to their own terms. 31 | 32 | 33 | ======================================================================= 34 | ======================================================================= 35 | ======================================================================= 36 | 37 | 38 | ## Creative Commons Attribution 4.0 International 39 | 40 | ======================================================================= 41 | 42 | Creative Commons Corporation ("Creative Commons") is not a law firm and 43 | does not provide legal services or legal advice. Distribution of 44 | Creative Commons public licenses does not create a lawyer-client or 45 | other relationship. Creative Commons makes its licenses and related 46 | information available on an "as-is" basis. Creative Commons gives no 47 | warranties regarding its licenses, any material licensed under their 48 | terms and conditions, or any related information. Creative Commons 49 | disclaims all liability for damages resulting from their use to the 50 | fullest extent possible. 51 | 52 | Using Creative Commons Public Licenses 53 | 54 | Creative Commons public licenses provide a standard set of terms and 55 | conditions that creators and other rights holders may use to share 56 | original works of authorship and other material subject to copyright 57 | and certain other rights specified in the public license below. The 58 | following considerations are for informational purposes only, are not 59 | exhaustive, and do not form part of our licenses. 60 | 61 | Considerations for licensors: Our public licenses are 62 | intended for use by those authorized to give the public 63 | permission to use material in ways otherwise restricted by 64 | copyright and certain other rights. Our licenses are 65 | irrevocable. Licensors should read and understand the terms 66 | and conditions of the license they choose before applying it. 67 | Licensors should also secure all rights necessary before 68 | applying our licenses so that the public can reuse the 69 | material as expected. Licensors should clearly mark any 70 | material not subject to the license. This includes other CC- 71 | licensed material, or material used under an exception or 72 | limitation to copyright. More considerations for licensors: 73 | wiki.creativecommons.org/Considerations_for_licensors 74 | 75 | Considerations for the public: By using one of our public 76 | licenses, a licensor grants the public permission to use the 77 | licensed material under specified terms and conditions. If 78 | the licensor's permission is not necessary for any reason--for 79 | example, because of any applicable exception or limitation to 80 | copyright--then that use is not regulated by the license. Our 81 | licenses grant only permissions under copyright and certain 82 | other rights that a licensor has authority to grant. Use of 83 | the licensed material may still be restricted for other 84 | reasons, including because others have copyright or other 85 | rights in the material. A licensor may make special requests, 86 | such as asking that all changes be marked or described. 87 | Although not required by our licenses, you are encouraged to 88 | respect those requests where reasonable. More considerations 89 | for the public: 90 | wiki.creativecommons.org/Considerations_for_licensees 91 | 92 | ======================================================================= 93 | 94 | Creative Commons Attribution 4.0 International Public License 95 | 96 | By exercising the Licensed Rights (defined below), You accept and agree 97 | to be bound by the terms and conditions of this Creative Commons 98 | Attribution 4.0 International Public License ("Public License"). To the 99 | extent this Public License may be interpreted as a contract, You are 100 | granted the Licensed Rights in consideration of Your acceptance of 101 | these terms and conditions, and the Licensor grants You such rights in 102 | consideration of benefits the Licensor receives from making the 103 | Licensed Material available under these terms and conditions. 104 | 105 | 106 | Section 1 -- Definitions. 107 | 108 | a. Adapted Material means material subject to Copyright and Similar 109 | Rights that is derived from or based upon the Licensed Material 110 | and in which the Licensed Material is translated, altered, 111 | arranged, transformed, or otherwise modified in a manner requiring 112 | permission under the Copyright and Similar Rights held by the 113 | Licensor. For purposes of this Public License, where the Licensed 114 | Material is a musical work, performance, or sound recording, 115 | Adapted Material is always produced where the Licensed Material is 116 | synched in timed relation with a moving image. 117 | 118 | b. Adapter's License means the license You apply to Your Copyright 119 | and Similar Rights in Your contributions to Adapted Material in 120 | accordance with the terms and conditions of this Public License. 121 | 122 | c. Copyright and Similar Rights means copyright and/or similar rights 123 | closely related to copyright including, without limitation, 124 | performance, broadcast, sound recording, and Sui Generis Database 125 | Rights, without regard to how the rights are labeled or 126 | categorized. For purposes of this Public License, the rights 127 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 128 | Rights. 129 | 130 | d. Effective Technological Measures means those measures that, in the 131 | absence of proper authority, may not be circumvented under laws 132 | fulfilling obligations under Article 11 of the WIPO Copyright 133 | Treaty adopted on December 20, 1996, and/or similar international 134 | agreements. 135 | 136 | e. Exceptions and Limitations means fair use, fair dealing, and/or 137 | any other exception or limitation to Copyright and Similar Rights 138 | that applies to Your use of the Licensed Material. 139 | 140 | f. Licensed Material means the artistic or literary work, database, 141 | or other material to which the Licensor applied this Public 142 | License. 143 | 144 | g. Licensed Rights means the rights granted to You subject to the 145 | terms and conditions of this Public License, which are limited to 146 | all Copyright and Similar Rights that apply to Your use of the 147 | Licensed Material and that the Licensor has authority to license. 148 | 149 | h. Licensor means the individual(s) or entity(ies) granting rights 150 | under this Public License. 151 | 152 | i. Share means to provide material to the public by any means or 153 | process that requires permission under the Licensed Rights, such 154 | as reproduction, public display, public performance, distribution, 155 | dissemination, communication, or importation, and to make material 156 | available to the public including in ways that members of the 157 | public may access the material from a place and at a time 158 | individually chosen by them. 159 | 160 | j. Sui Generis Database Rights means rights other than copyright 161 | resulting from Directive 96/9/EC of the European Parliament and of 162 | the Council of 11 March 1996 on the legal protection of databases, 163 | as amended and/or succeeded, as well as other essentially 164 | equivalent rights anywhere in the world. 165 | 166 | k. You means the individual or entity exercising the Licensed Rights 167 | under this Public License. Your has a corresponding meaning. 168 | 169 | 170 | Section 2 -- Scope. 171 | 172 | a. License grant. 173 | 174 | 1. Subject to the terms and conditions of this Public License, 175 | the Licensor hereby grants You a worldwide, royalty-free, 176 | non-sublicensable, non-exclusive, irrevocable license to 177 | exercise the Licensed Rights in the Licensed Material to: 178 | 179 | a. reproduce and Share the Licensed Material, in whole or 180 | in part; and 181 | 182 | b. produce, reproduce, and Share Adapted Material. 183 | 184 | 2. Exceptions and Limitations. For the avoidance of doubt, where 185 | Exceptions and Limitations apply to Your use, this Public 186 | License does not apply, and You do not need to comply with 187 | its terms and conditions. 188 | 189 | 3. Term. The term of this Public License is specified in Section 190 | 6(a). 191 | 192 | 4. Media and formats; technical modifications allowed. The 193 | Licensor authorizes You to exercise the Licensed Rights in 194 | all media and formats whether now known or hereafter created, 195 | and to make technical modifications necessary to do so. The 196 | Licensor waives and/or agrees not to assert any right or 197 | authority to forbid You from making technical modifications 198 | necessary to exercise the Licensed Rights, including 199 | technical modifications necessary to circumvent Effective 200 | Technological Measures. For purposes of this Public License, 201 | simply making modifications authorized by this Section 2(a) 202 | (4) never produces Adapted Material. 203 | 204 | 5. Downstream recipients. 205 | 206 | a. Offer from the Licensor -- Licensed Material. Every 207 | recipient of the Licensed Material automatically 208 | receives an offer from the Licensor to exercise the 209 | Licensed Rights under the terms and conditions of this 210 | Public License. 211 | 212 | b. No downstream restrictions. You may not offer or impose 213 | any additional or different terms or conditions on, or 214 | apply any Effective Technological Measures to, the 215 | Licensed Material if doing so restricts exercise of the 216 | Licensed Rights by any recipient of the Licensed 217 | Material. 218 | 219 | 6. No endorsement. Nothing in this Public License constitutes or 220 | may be construed as permission to assert or imply that You 221 | are, or that Your use of the Licensed Material is, connected 222 | with, or sponsored, endorsed, or granted official status by, 223 | the Licensor or others designated to receive attribution as 224 | provided in Section 3(a)(1)(A)(i). 225 | 226 | b. Other rights. 227 | 228 | 1. Moral rights, such as the right of integrity, are not 229 | licensed under this Public License, nor are publicity, 230 | privacy, and/or other similar personality rights; however, to 231 | the extent possible, the Licensor waives and/or agrees not to 232 | assert any such rights held by the Licensor to the limited 233 | extent necessary to allow You to exercise the Licensed 234 | Rights, but not otherwise. 235 | 236 | 2. Patent and trademark rights are not licensed under this 237 | Public License. 238 | 239 | 3. To the extent possible, the Licensor waives any right to 240 | collect royalties from You for the exercise of the Licensed 241 | Rights, whether directly or through a collecting society 242 | under any voluntary or waivable statutory or compulsory 243 | licensing scheme. In all other cases the Licensor expressly 244 | reserves any right to collect such royalties. 245 | 246 | 247 | Section 3 -- License Conditions. 248 | 249 | Your exercise of the Licensed Rights is expressly made subject to the 250 | following conditions. 251 | 252 | a. Attribution. 253 | 254 | 1. If You Share the Licensed Material (including in modified 255 | form), You must: 256 | 257 | a. retain the following if it is supplied by the Licensor 258 | with the Licensed Material: 259 | 260 | i. identification of the creator(s) of the Licensed 261 | Material and any others designated to receive 262 | attribution, in any reasonable manner requested by 263 | the Licensor (including by pseudonym if 264 | designated); 265 | 266 | ii. a copyright notice; 267 | 268 | iii. a notice that refers to this Public License; 269 | 270 | iv. a notice that refers to the disclaimer of 271 | warranties; 272 | 273 | v. a URI or hyperlink to the Licensed Material to the 274 | extent reasonably practicable; 275 | 276 | b. indicate if You modified the Licensed Material and 277 | retain an indication of any previous modifications; and 278 | 279 | c. indicate the Licensed Material is licensed under this 280 | Public License, and include the text of, or the URI or 281 | hyperlink to, this Public License. 282 | 283 | 2. You may satisfy the conditions in Section 3(a)(1) in any 284 | reasonable manner based on the medium, means, and context in 285 | which You Share the Licensed Material. For example, it may be 286 | reasonable to satisfy the conditions by providing a URI or 287 | hyperlink to a resource that includes the required 288 | information. 289 | 290 | 3. If requested by the Licensor, You must remove any of the 291 | information required by Section 3(a)(1)(A) to the extent 292 | reasonably practicable. 293 | 294 | 4. If You Share Adapted Material You produce, the Adapter's 295 | License You apply must not prevent recipients of the Adapted 296 | Material from complying with this Public License. 297 | 298 | 299 | Section 4 -- Sui Generis Database Rights. 300 | 301 | Where the Licensed Rights include Sui Generis Database Rights that 302 | apply to Your use of the Licensed Material: 303 | 304 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 305 | to extract, reuse, reproduce, and Share all or a substantial 306 | portion of the contents of the database; 307 | 308 | b. if You include all or a substantial portion of the database 309 | contents in a database in which You have Sui Generis Database 310 | Rights, then the database in which You have Sui Generis Database 311 | Rights (but not its individual contents) is Adapted Material; and 312 | 313 | c. You must comply with the conditions in Section 3(a) if You Share 314 | all or a substantial portion of the contents of the database. 315 | 316 | For the avoidance of doubt, this Section 4 supplements and does not 317 | replace Your obligations under this Public License where the Licensed 318 | Rights include other Copyright and Similar Rights. 319 | 320 | 321 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 322 | 323 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 324 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 325 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 326 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 327 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 328 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 329 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 330 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 331 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 332 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 333 | 334 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 335 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 336 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 337 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 338 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 339 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 340 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 341 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 342 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 343 | 344 | c. The disclaimer of warranties and limitation of liability provided 345 | above shall be interpreted in a manner that, to the extent 346 | possible, most closely approximates an absolute disclaimer and 347 | waiver of all liability. 348 | 349 | 350 | Section 6 -- Term and Termination. 351 | 352 | a. This Public License applies for the term of the Copyright and 353 | Similar Rights licensed here. However, if You fail to comply with 354 | this Public License, then Your rights under this Public License 355 | terminate automatically. 356 | 357 | b. Where Your right to use the Licensed Material has terminated under 358 | Section 6(a), it reinstates: 359 | 360 | 1. automatically as of the date the violation is cured, provided 361 | it is cured within 30 days of Your discovery of the 362 | violation; or 363 | 364 | 2. upon express reinstatement by the Licensor. 365 | 366 | For the avoidance of doubt, this Section 6(b) does not affect any 367 | right the Licensor may have to seek remedies for Your violations 368 | of this Public License. 369 | 370 | c. For the avoidance of doubt, the Licensor may also offer the 371 | Licensed Material under separate terms or conditions or stop 372 | distributing the Licensed Material at any time; however, doing so 373 | will not terminate this Public License. 374 | 375 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 376 | License. 377 | 378 | 379 | Section 7 -- Other Terms and Conditions. 380 | 381 | a. The Licensor shall not be bound by any additional or different 382 | terms or conditions communicated by You unless expressly agreed. 383 | 384 | b. Any arrangements, understandings, or agreements regarding the 385 | Licensed Material not stated herein are separate from and 386 | independent of the terms and conditions of this Public License. 387 | 388 | 389 | Section 8 -- Interpretation. 390 | 391 | a. For the avoidance of doubt, this Public License does not, and 392 | shall not be interpreted to, reduce, limit, restrict, or impose 393 | conditions on any use of the Licensed Material that could lawfully 394 | be made without permission under this Public License. 395 | 396 | b. To the extent possible, if any provision of this Public License is 397 | deemed unenforceable, it shall be automatically reformed to the 398 | minimum extent necessary to make it enforceable. If the provision 399 | cannot be reformed, it shall be severed from this Public License 400 | without affecting the enforceability of the remaining terms and 401 | conditions. 402 | 403 | c. No term or condition of this Public License will be waived and no 404 | failure to comply consented to unless expressly agreed to by the 405 | Licensor. 406 | 407 | d. Nothing in this Public License constitutes or may be interpreted 408 | as a limitation upon, or waiver of, any privileges and immunities 409 | that apply to the Licensor or You, including from the legal 410 | processes of any jurisdiction or authority. 411 | 412 | 413 | ======================================================================= 414 | 415 | Creative Commons is not a party to its public 416 | licenses. Notwithstanding, Creative Commons may elect to apply one of 417 | its public licenses to material it publishes and in those instances 418 | will be considered the “Licensor.” The text of the Creative Commons 419 | public licenses is dedicated to the public domain under the CC0 Public 420 | Domain Dedication. Except for the limited purpose of indicating that 421 | material is shared under a Creative Commons public license or as 422 | otherwise permitted by the Creative Commons policies published at 423 | creativecommons.org/policies, Creative Commons does not authorize the 424 | use of the trademark "Creative Commons" or any other trademark or logo 425 | of Creative Commons without its prior written consent including, 426 | without limitation, in connection with any unauthorized modifications 427 | to any of its public licenses or any other arrangements, 428 | understandings, or agreements concerning use of licensed material. For 429 | the avoidance of doubt, this paragraph does not form part of the 430 | public licenses. 431 | 432 | Creative Commons may be contacted at creativecommons.org. 433 | 434 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spatial LibriSpeech 2 | 3 | Spatial LibriSpeech, is a spatial audio dataset with over 650 hours of first-order 4 | ambisonics, and optional distractor noise (with raw 19-channel audio coming soon). Spatial LibriSpeech is designed for machine learning 5 | model training, and it includes labels for source position, speaking direction, room acoustics and 6 | geometry. Spatial LibriSpeech was generated by augmenting LibriSpeech samples with 200k+ simulated 7 | acoustic conditions across 8k+ synthetic rooms. 8 | 9 | For more information, refer to our paper: https://doi.org/10.21437/Interspeech.2023-2117. 10 | 11 | If you use Spatial LibriSpeech in a publication, please cite our paper: 12 | ``` 13 | @inproceedings{spatial_librispeech2023, 14 | author={Miguel Sarabia and Elena Menyaylenko and Alessandro Toso and Skyler Seto 15 | and Zakaria Aldeneh and Shadi Pirhosseinloo and Luca Zappella 16 | and Barry-John Theobald and Nicholas Apostoloff and Jonathan Sheaffer}, 17 | title={{Spatial LibriSpeech: An Augmented Dataset for Spatial Audio Learning}}, 18 | year={2023}, 19 | booktitle={Proc. Interspeech}, 20 | pages={3724--3728}, 21 | doi={10.21437/Interspeech.2023-2117} 22 | } 23 | ``` 24 | 25 | ## 📜 License 26 | 27 | By downloading and using Spatial LibriSpeech, you are agreeing to comply with 28 | the terms of its [LICENSE](LICENSE). 29 | 30 | ## 💾 Download 31 | Our downloader script & pytorch dataloader will be uploaded soon. 32 | 33 | ### Manual download 34 | In the meantime, all our files are hosted here: 35 | ```python3 36 | SLS_URI = "https://docs-assets.developer.apple.com/ml-research/datasets/spatial-librispeech/v1" 37 | ``` 38 | You can manually download the metadata from here. Refer to [dataset schema](DATASET_SCHEMA.md) 39 | for more information about how the data is structured. 40 | ```python3 41 | f"{SLS_URI}/metadata.parquet" 42 | ``` 43 | Using the metadata you can manually download samples with: 44 | ```python3 45 | # speech first order ambisonics samples 46 | f"{SLS_URI}/ambisonics/{sample_id:06}.flac" 47 | # distractor noise first order ambisonics samples 48 | f"{SLS_URI}/noise_ambisonics/{sample_id:06}.flac" 49 | ``` 50 | 51 | So, for instance, you may download the metadata with this command: 52 | ```bash 53 | curl -O https://docs-assets.developer.apple.com/ml-research/datasets/spatial-librispeech/v1/metadata.parquet 54 | ``` 55 | And the first speech sample with: 56 | ```bash 57 | curl -O https://docs-assets.developer.apple.com/ml-research/datasets/spatial-librispeech/v1/ambisonics/000000.flac 58 | ``` 59 | 60 | ⚠️ 19-channel speech and distractor noise samples are very large and we are evaluating how to best host them. If 61 | you need them in the meantime, please contact us. 62 | 63 | ## ✉️ Contact 64 | 65 | * [spatial-librispeech-dataset@group.apple.com](mailto:spatial-librispeech-dataset@group.apple.com) 66 | --------------------------------------------------------------------------------