SAF
Loading...
Searching...
No Matches
saf_sofa_reader.h File Reference

Main header for the sofa reader module (SAF_SOFA_READER_MODULE) More...

#include "libmysofa/mysofa.h"

Go to the source code of this file.

Data Structures

struct  saf_sofa_container
 SOFA container struct comprising all possible data that can be extracted from SOFA 1.0 files; as laid down in the GeneralFIR and SimpleFreeFieldHRIR specifications: https://www.sofaconventions.org/mediawiki/index.php/GeneralFIR https://www.sofaconventions.org/mediawiki/index.php/SimpleFreeFieldHRIR. More...
 

Enumerations

enum  SAF_SOFA_READER_OPTIONS { SAF_SOFA_READER_OPTION_DEFAULT , SAF_SOFA_READER_OPTION_LIBMYSOFA , SAF_SOFA_READER_OPTION_NETCDF }
 SOFA file reader options. More...
 
enum  SAF_SOFA_ERROR_CODES {
  SAF_SOFA_OK , SAF_SOFA_ERROR_INVALID_FILE_OR_FILE_PATH , SAF_SOFA_ERROR_DIMENSIONS_UNEXPECTED , SAF_SOFA_ERROR_FORMAT_UNEXPECTED ,
  SAF_SOFA_ERROR_NETCDF_IN_USE
}
 SOFA loader error codes. More...
 

Functions

SAF_SOFA_ERROR_CODES saf_sofa_open (saf_sofa_container *hSOFA, char *sofa_filepath, SAF_SOFA_READER_OPTIONS option)
 Fills a 'sofa_container' with data found in a SOFA file (GeneralFIR or SimpleFreeFieldHRIR), as detailed in the SOFA 1.0 standard [1,2,3].
 
void saf_sofa_close (saf_sofa_container *hSOFA)
 Frees all SOFA data in a sofa_container.
 

Detailed Description

Main header for the sofa reader module (SAF_SOFA_READER_MODULE)

Note
This SOFA reader may optionally use netcdf if "SAF_ENABLE_NETCDF" is defined. Otherwise, the reader will use libmysofa [1] in conjunction with zlib, which is included in framework/resources/zlib; i.e. no external libraries need to be linked by default.
See also
[1] https://github.com/hoene/libmysofa (BSD-3-Clause license)
Author
Leo McCormack
Date
21.11.2017
License
ISC

Definition in file saf_sofa_reader.h.