Skip to content

Commit ff4660a

Browse files
committed
fix mentions of outdated AES69-2020
1 parent 7af1014 commit ff4660a

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ applications that read or write SOFA data. Test data violating the conventions
66
are contained in *data*. This data is intended for testing if an application
77
correctly verifies data against AES69 when reading it.
88

9-
**Conventions are implemented according to AES69-2022
9+
**Conventions are implemented according to AES69
1010
(SOFA conventions version 2.1)**
1111

12+
AES69-2022: *AES standard for file exchange - Spatial acoustic data file
13+
format*, Audio Engineering Society, Inc., New York, NY, USA.
14+
1215
Updating the conventions and data requires the sofar package available from
1316
<https://github.com/pyfar/sofar> and can be installed via
1417

@@ -29,9 +32,6 @@ To update the conventions from <https://sofaconventions.org/conventions>:
2932
- merge to master branch
3033
- update *sofa_conventions* submodule in sofar
3134

32-
AES69-2022: *AES standard for file exchange - Spatial acoustic data file
33-
format*, Audio Engineering Society, Inc., New York, NY, USA.
34-
3535
## 1. Conventions
3636

3737
This folder contains the official SOFA conventions as json and csv files. SOFA
@@ -95,7 +95,7 @@ and the verification rules. The verification requires the following steps:
9595
7. All verification rules from rules.json must be checked (see below)
9696

9797
The json files inside this folder contain rules for verifying SOFA files.
98-
The rules were manually extracted from the SOFA Standard AES69-2020. Note that
98+
The rules were manually extracted from the SOFA Standard AES69. Note that
9999
the json files are written with `write_verification_rules.py` where additional
100100
comments on the rules can be found.
101101

write_verification_rules.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@
3636
coords_min = ["cartesian", "spherical"]
3737
coords_full = coords_min + ["spherical harmonics"]
3838

39-
# definition of units acordings to AES69-2020 Table 7
39+
# definition of units acordings to AES69 Table 7
4040
units_min = ["metre", "degree, degree, metre"]
4141
units_full = units_min + [units_min[1]]
4242

4343
# allowed alternative versions of units
4444
# NOTE: AES69 allows multi-unit strings to be separated by comma, comma plus
45-
# space and space (AES69-2020 Section 4.7.8). This means that the unit
45+
# space and space (AES69 Section 4.7.8). This means that the unit
4646
# "cubic metre" will be tested as a multi unit string and is thus also
4747
# split in the aliases. A separate test for verifying that "cubic" is
4848
# followed be "metre" must be performed.
@@ -59,18 +59,18 @@
5959
}
6060
# possible values for restricted dimensions in the API
6161
# Dimensions for spherical harmonics (considering orders up to 100) according
62-
# to AES69-2020 Eq. (5) and (6)
62+
# to AES69 Eq. (5) and (6)
6363
sh_dimension = ([(N+1)**2 for N in range(100)],
6464
"(N+1)**2 where N is the spherical harmonics order")
65-
# Dimensions for SOS (considering up to 100 sections) according to AES69-2020
66-
# Appenx C.5.2
65+
# Dimensions for SOS (considering up to 100 sections) according to AES69
66+
# Appendix C.5.2
6767
sos_dimension = ([6 * (N + 1) for N in range(100)],
6868
"an integer multiple of 6 greater 0")
6969

7070
# verification rules
7171
rules = {
7272
# Global --------------------------------------------------------------
73-
# Check value of GLOBAL_DataType (AES69-2020 Annex C)
73+
# Check value of GLOBAL_DataType (AES69 Annex C)
7474
# (FIRE and TFE are legacy data types from SOFA version 1.0)
7575
"GLOBAL:DataType": {
7676
"value": ["Audio", "FIR", "FIR-E", "FIRE", "TF", "TF-E", "SOS"],
@@ -120,7 +120,7 @@
120120
"value": sos_dimension[0],
121121
"value_str": sos_dimension[1]}
122122
}}}},
123-
# Specified in AES69-2020 SEction 4.7.7 and Table 6
123+
# Specified in AES69 Section 4.7.7 and Table 6
124124
"GLOBAL:RoomType": {
125125
"value": ["free field", "reverberant", "shoebox", "dae"],
126126
"specific": {
@@ -131,7 +131,7 @@
131131
"RoomCornerB": None},
132132
"dae": {
133133
"GLOBAL:RoomGeometry": None}}},
134-
# Specified in AES69-2020 Annex D
134+
# Specified in AES69 Annex D
135135
"GLOBAL:SOFAConventions": {
136136
"value": _get_conventions(return_type="name"),
137137
"specific": {
@@ -185,12 +185,12 @@
185185
"GLOBAL:DataType": ["FIR-E"]},
186186
"FreeFieldDirectivityTF": {
187187
"GLOBAL:DataType": ["TF"]}}},
188-
# check NLongName (AES69-2020 Tables C.3 and C.4)
188+
# check NLongName (AES69 Tables C.3 and C.4)
189189
"N:LongName": {
190190
"value": ["frequency"]},
191191
# Listener ------------------------------------------------------------
192192
# Possible values and dependencies are specified in
193-
# AES69-2020 Section 4.7.3
193+
# AES69 Section 4.7.3
194194
# ---------------------------------------------------------------------
195195
# Check values and consistency of if ListenerPosition Type and Unit
196196
"ListenerPosition:Type": {
@@ -220,7 +220,7 @@
220220
"general": ["ListenerView"]},
221221
# Receiver ------------------------------------------------------------
222222
# Possible values and dependencies are specified in
223-
# AES69-2020 Section 4.7.4
223+
# AES69 Section 4.7.4
224224
# ---------------------------------------------------------------------
225225
# Check values and consistency of if ReceiverPosition Type and Unit
226226
"ReceiverPosition:Type": {
@@ -258,7 +258,7 @@
258258
"general": ["ReceiverView"]},
259259
# Source --------------------------------------------------------------
260260
# Possible values and dependencies are specified in
261-
# AES69-2020 Section 4.7.5
261+
# AES69 Section 4.7.5
262262
# ---------------------------------------------------------------------
263263
# Check values and consistency of if SourcePosition Type and Unit
264264
"SourcePosition:Type": {
@@ -288,7 +288,7 @@
288288
"general": ["SourceView"]},
289289
# Emitter -------------------------------------------------------------
290290
# Possible values and dependencies are specified in
291-
# AES69-2020 Section 4.7.6
291+
# AES69 Section 4.7.6
292292
# ---------------------------------------------------------------------
293293
# Check values and consistency of if EmitterPosition Type and Unit
294294
"EmitterPosition:Type": {
@@ -331,7 +331,7 @@
331331
"general": ["GLOBAL:EmitterDescription"]},
332332
# Room ----------------------------------------------------------------
333333
# Possible values and dependencies are specified in
334-
# AES69-2020 Section 4.7.7
334+
# AES69 Section 4.7.7
335335
# ---------------------------------------------------------------------
336336
"RoomVolume": {
337337
"value": None,

0 commit comments

Comments
 (0)