A Lightweight Python API for the AES69-2015 Spatially Oriented Format for Acoustics (SOFA) File Format


Keywords
SOFA, Spatially, Oriented, Format, For, Acoustics, Audio, 3D, Binaural, Transaural, audio-analysis, audio-applications, binauralaudio, python, sofa-files
License
BSD-3-Clause
Install
pip install SOFASonix==1.0.31

Documentation

Python License

SOFASonix is an advanced Python API for the Spatially-Oriented Format for Acoustics (SOFA Format) as defined by AES69-2015 - www.sofaconventions.org.

SOFASonix was initially developed as a supplementary tool for usage alongside an undergraduate project at Southampton University's Institute of Sound and Vibration Research (ISVR). The enhanced and refined version of this is now the official SOFASonix API.

Features

  • Support for the majority of standardised and stable SOFA conventions.
  • Reading/Writing of SOFA Files for each of the supported conventions.
  • Built-in convention-specific validation to ensure correct file format for export!
  • Powered by the lightweight and powerful SQLite3, providing support for different versions of each convention.
  • Simple syntax for quickly generating / reading SOFA files.

Installation

SOFASonix can be installed as a PyPI package using

pip install sofasonix

Supported Conventions

The following conventions are currently supported by SOFASonix for reading and writing, as per the SOFAConventions website:

Convention Version SOFAConventionsVersion
GeneralFIR 1.0 1.0
GeneralTF 1.0 1.0
0.5 0.1
SimpleFreeFieldHRIR 1.0 1.0
0.6 0.4
0.5 0.3
GeneralFIRE 1.0 1.0
0.6 0.1
MultiSpeakerBRIR 1.0 0.3
0.6 0.2
0.6 0.1
SimpleHeadphoneIR 1.0 0.2
0.6 0.1
0.5 0.1
SimpleFreeFieldTF 1.0 1.0
0.6 0.4
SimpleFreeFieldSOS 1.0 1.0
SingleRoomDRIR 1.0 0.3
0.5 0.1
MusicalInstrumentDirectivity 1.0 1.0
FreeFieldDirectivityTF 1.0 0.1

Note: While some of these versions are deprecated according to SOFAConventions, they have been included to maintain backwards compatibility for both older SOFA files and older applications that may be using them. It is always recommended to use the latest versions for generating files for storage.

Documentation

SOFASonix documentation and example usage is available over at the SOFASonix Wiki page.

Templates

SOFASonix supports templates for each convention for easily creating SOFA files. These templates are autogenerated with the provided TemplateGenerator. The TemplateGenerator may be used to create python templates for any convention (and version combinations) supported by SOFASonix. To learn more, refer to the SOFASonix WIKI page.

Contribute

You may contribute any improvements and fixes via regular pull-requests. These will be reviewed as per standard procedure before integration.

License

SOFASonix is licensed under BSD-3 - see the LICENSE.md file for details. Alternatively you may visit https://opensource.org/licenses/BSD-3-Clause

Authors

I.G Laghidze (Founder) - developer@artisan-one.com