SOFA conventions: Difference between revisions
New soonish standardized conventions added |
deprecated conventions added |
||
| Line 41: | Line 41: | ||
* [[SingleRoomSRIR]]: spatial room impulse responses (SRIRs) measured with an arbitrary number of receivers (R>1, such as a microphone array) and an omnidirectional source (E=1) in a single room. SingleRoomSRIR is the standardized version of the previously proposed SingleRoomDRIR. |
* [[SingleRoomSRIR]]: spatial room impulse responses (SRIRs) measured with an arbitrary number of receivers (R>1, such as a microphone array) and an omnidirectional source (E=1) in a single room. SingleRoomSRIR is the standardized version of the previously proposed SingleRoomDRIR. |
||
* [[SingleRoomMIMOIR]]: SRIRs measured with a compact listener containing an arbitrary number of receivers (R>1, such as a compact microphone array) and a compact source containing an arbitrary number of receivers (E>1, such as a multi-emitter loudspeaker) for multiple positions and/or orientations of the listener and/or source, in a single room. |
* [[SingleRoomMIMOIR]]: SRIRs measured with a compact listener containing an arbitrary number of receivers (R>1, such as a compact microphone array) and a compact source containing an arbitrary number of receivers (E>1, such as a multi-emitter loudspeaker) for multiple positions and/or orientations of the listener and/or source, in a single room. |
||
| ⚫ | |||
Note: Any modification in one of these conventions changes its status to "stable", i.e., not standardized anymore, unless the modification will be approved the AES. |
Note: Any modification in one of these conventions changes its status to "stable", i.e., not standardized anymore, unless the modification will be approved the AES. |
||
| Line 46: | Line 48: | ||
==Stable SOFA conventions== |
==Stable SOFA conventions== |
||
Stable SOFA conventions are those for which SOFA files are publicly available and can be read/modified by at least one publicly available software package. |
Stable SOFA conventions are those for which SOFA files are publicly available and can be read/modified by at least one publicly available software package. |
||
* [[GeneralFIRE]]: General convention with FIRE as DataType (no restrictions but DataType). |
|||
| ⚫ | |||
* [[SimpleFreeFieldTF]]: as SimpleFreeFieldHRIR, but uses TF as DataType covering special needs coming from HRTF simulations. |
|||
* [[SimpleFreeFieldSOS]]: as SimpleFreeFieldHRIR, but uses SOS as DataType (second-order sections) covering special needs coming from HRTF rendering. |
|||
* [[SingleRoomDRIR]]: directional room impulse responses (DRIRs) measured with an arbitrary number of ''receivers'' (such as a microphone array) and an omnidirectional source in a single room. |
|||
* [[MultiSpeakerBRIR]]: binaural room impulse responses (BRIRs) measured with an arbitrary number of ''emitters'' (such as a loudspeaker array). |
* [[MultiSpeakerBRIR]]: binaural room impulse responses (BRIRs) measured with an arbitrary number of ''emitters'' (such as a loudspeaker array). |
||
| Line 58: | Line 55: | ||
==Proposed SOFA conventions== |
==Proposed SOFA conventions== |
||
Proposed SOFA conventions are |
Proposed SOFA conventions are those being currently discussed and considered as work in progress. If you would like to propose a new convention, consider the following rules: |
||
* Data must exist (do not foresee the future) |
* Data must exist (do not foresee the future) |
||
* Data can not be described by existing SOFA conventions |
* Data can not be described by existing SOFA conventions |
||
* Relevant information about the data available |
* Relevant information about the data available |
||
There are currently no proposed conventions. |
|||
The following SOFA conventions are being discussed. Measured data exist but their description must be fixed in order to create publicly available SOFA files and corresponding software interfaces. |
|||
* [[SimpleFreeFieldDirectivityTF]]: Convention for storing directivity of musical instruments in the frequency domain. Directivity stored as relation between Source and Listener. (It was previously FreeFieldDirectivityTF and MusicalInstrumentDirectivityTF). |
|||
* [[SimpleBRIR]]: Binaural room impulse responses measured with an omnidirectional source in a single reverberant space. Somebody wanted to have this, but the work stopped at the moment. |
|||
== Ideas for future conventions == |
== Ideas for future conventions == |
||
| Line 76: | Line 72: | ||
Please use the "Discussion" function to discuss these topics. |
Please use the "Discussion" function to discuss these topics. |
||
==Deprecated SOFA conventions== |
|||
These conventions are deprecated because their proposal has changed or they have been standardized under different name. They are listed here for the sake of completeness only. When reading a SOFA file with a deprecated convention, convert to that stated below: |
|||
* [[FreeFieldDirectivityTF]]: use [[SimpleFreeFieldDirectivityTF]] instead. |
|||
* [[MusicalInstrumentDirectivityTF]]: use [[SimpleFreeFieldDirectivityTF]] instead. |
|||
* [[SimpleBRIR]]: use [[MultiSpeakerBRIR]] instead. |
|||
* [[GeneralFIRE]]: use [[GeneralFIR-E]] instead. |
|||
* [[SimpleFreeFieldTF]]: use [[SimpleFreeFieldHRTF]] instead. |
|||
* [[SimpleFreeFieldSOS]]: use [[SimpleFreeFieldHRSOS]] instead. |
|||
* [[SingleRoomDRIR]]: use [[SingleRoomSRIR]] instead. |
|||
We strongly discourage from saving data with those conventions. |
|||
Revision as of 17:39, 4 August 2020
SOFA conventions specify the description of data and metadata for a particular kind of measured data.
This is important in order to meet the different requirements coming from different application fields, specified. For example, description of HRTFs, BRIRs, and DRIRs requires different metadata. Also, some applications may prefer to see the data stored in a different way. These conventions, once approved by the peer group are defined in SOFA conventions.
Specification of conventions are displayed in tables using the following legend:
- Name: the name of the metadata
- A colon: the metadata is an attribute
- "GLOBAL:": the metadata is a global attribute
- "X:Y": the metadata is an attribute Y of the variable X
- No colon: the metadata is a variable
- Data.X: the metadata is structured within the data
- A colon: the metadata is an attribute
- Default: default value for the metadata
- An asterisk (*): special handling required, mentioned in the column Comment
- Flags:
- r: read-only, must be the default value
- m: mandatory, must be saved in the file
- Dimensions: dimensions of the metadata (see SOFA specifications for more explanations)
- lower case: the variable size in that dimension determines the dimension size in the file
- upper case: variable must be of that dimension (or one of these dimensions)
Standardized SOFA conventions
Standardized SOFA conventions are those which have been standardized by the AES.
As with AES69-2015 (SOFA 1.0), we have:
- GeneralFIR: General convention with FIR as DataType (no restrictions but DataType)
- GeneralTF: General convention with TF as DataType (no restrictions but DataType)
- SimpleFreeFieldHRIR: Free-field HRTFs stored as impulse responses, measured with an omnidirectional source for a single listener.
As with AES69-2015 (SOFA 1.1), we are currently working on:
- GeneralFIR-E: General convention with FIR-E as DataType (no restrictions but DataType). GeneralFIR-E is the standardized version of the previously proposed GeneralFIR convention. It extends GeneralFIR by having Emitter as an explicit dimension in the data.
- GeneralTF-E: General convention with TF-E as DataType (no restrictions but DataType). GeneralTF-E extends GeneralTF by having Emitter as an explicit dimension in the data.
- General: General convention with any datatype (no restrictions at all).
- SimpleFreeFieldHRTF: Free-field HRTFs stored as transfer functions, measured with an omnidirectional source for a single listener. Based on SimpleFreeFieldHRIR, the only difference is the DataType, that is TF.
- SimpleFreeFieldHRSOS: Free-field HRTFs stored as second-order sections, measured with an omnidirectional source for a single listener. Based on SimpleFreeFieldHRIR, the only difference is the DataType, that is SOS.
- SHFreeFieldHRTF: Free-field HRTFs stored as transfer functions in the spherical-harmonics domain, measured with an omnidirectional source for a single listener. Based on SimpleFreeFieldHRTF, the only difference is that the HRTFs are in a spatially continuous representation.
- SimpleFreeFieldDirectivityTF: Convention for storing directivities of musical instruments or loudspeakers at spatial discrete points in the frequency domain. SimpleFreeFieldDirectivityTF is the standardized version of the previously proposed FreeFieldDirectivityTF and MusicalInstrumentDirectivityTF.
- SingleRoomSRIR: spatial room impulse responses (SRIRs) measured with an arbitrary number of receivers (R>1, such as a microphone array) and an omnidirectional source (E=1) in a single room. SingleRoomSRIR is the standardized version of the previously proposed SingleRoomDRIR.
- SingleRoomMIMOIR: SRIRs measured with a compact listener containing an arbitrary number of receivers (R>1, such as a compact microphone array) and a compact source containing an arbitrary number of receivers (E>1, such as a multi-emitter loudspeaker) for multiple positions and/or orientations of the listener and/or source, in a single room.
- SimpleHeadphoneIR: Conventions to store headphone IRs recorded for each emitter and each ear, single listener and no directionality of emitter/receiver considered.
Note: Any modification in one of these conventions changes its status to "stable", i.e., not standardized anymore, unless the modification will be approved the AES.
Stable SOFA conventions
Stable SOFA conventions are those for which SOFA files are publicly available and can be read/modified by at least one publicly available software package.
- MultiSpeakerBRIR: binaural room impulse responses (BRIRs) measured with an arbitrary number of emitters (such as a loudspeaker array).
These conventions, when used often and widely, can be proposed for standardization to the AES.
Proposed SOFA conventions
Proposed SOFA conventions are those being currently discussed and considered as work in progress. If you would like to propose a new convention, consider the following rules:
- Data must exist (do not foresee the future)
- Data can not be described by existing SOFA conventions
- Relevant information about the data available
There are currently no proposed conventions.
Ideas for future conventions
Here we list the suggestions and feedback from the peer group:
- Include anthropometric data
- Crosstalk cancellation filters
- Include calibration data from the measurement
- Include room pictures
Please use the "Discussion" function to discuss these topics.
Deprecated SOFA conventions
These conventions are deprecated because their proposal has changed or they have been standardized under different name. They are listed here for the sake of completeness only. When reading a SOFA file with a deprecated convention, convert to that stated below:
- FreeFieldDirectivityTF: use SimpleFreeFieldDirectivityTF instead.
- MusicalInstrumentDirectivityTF: use SimpleFreeFieldDirectivityTF instead.
- SimpleBRIR: use MultiSpeakerBRIR instead.
- GeneralFIRE: use GeneralFIR-E instead.
- SimpleFreeFieldTF: use SimpleFreeFieldHRTF instead.
- SimpleFreeFieldSOS: use SimpleFreeFieldHRSOS instead.
- SingleRoomDRIR: use SingleRoomSRIR instead.
We strongly discourage from saving data with those conventions.
Feedback and Contribution
If you would like to contribute or propose new SOFA conventions:
- Send an e-mail to the mailing list. You don't have to be a member of the mailing list to send a message to the moderator.
- Go to one of the SOFA pages of your interest and use the "Discussion" for your contribution.
We appreciate your feedback!