saf_sofa_reader.h

Go to the documentation of this file.

/*
 * Copyright 2017-2018 Leo McCormack
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef __SAF_SOFA_READER_H_INCLUDED__
#define __SAF_SOFA_READER_H_INCLUDED__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#ifdef SAF_ENABLE_SOFA_READER_MODULE
 
#include "libmysofa/mysofa.h"
 
typedef enum{
    SAF_SOFA_READER_OPTION_DEFAULT,
 
    SAF_SOFA_READER_OPTION_LIBMYSOFA,
 
    SAF_SOFA_READER_OPTION_NETCDF
 
} SAF_SOFA_READER_OPTIONS;
 
 
/* ========================================================================== */
/*                          Public Structures/Enums                           */
/* ========================================================================== */
 
typedef struct _saf_sofa_container{
    /* All possible SOFA variables (defaults={-1|NULL}) */
    int nSources;                 
    int nReceivers;               
    int DataLengthIR;             
    float* DataIR;                
    float DataSamplingRate;       
    float* DataDelay;             
    float* SourcePosition;        
    float* ReceiverPosition;      
    int nListeners;               
    int nEmitters;                
    float* ListenerPosition;      
    float* ListenerUp;            
    float* ListenerView;          
    float* EmitterPosition;       
    /* All possible SOFA variable attributes (defaults=NULL) */
    char* ListenerPositionType;   
    char* ListenerPositionUnits;  
    char* ListenerViewType;       
    char* ListenerViewUnits;      
    char* ReceiverPositionType;   
    char* ReceiverPositionUnits;  
    char* SourcePositionType;     
    char* SourcePositionUnits;    
    char* EmitterPositionType;    
    char* EmitterPositionUnits;   
    char* DataSamplingRateUnits;  
    /* All possible SOFA global attributes (defaults=NULL) */
    char* Conventions;            
    char* Version;                
    char* SOFAConventions;        
    char* SOFAConventionsVersion; 
    char* APIName;                
    char* APIVersion;             
    char* ApplicationName;        
    char* ApplicationVersion;     
    char* AuthorContact;          
    char* Comment;                
    char* DataType;               
    char* History;                
    char* License;                
    char* Organisation;           
    char* References;             
    char* RoomType;               
    char* Origin;                 
    char* DateCreated;            
    char* DateModified;           
    char* Title;                  
    char* DatabaseName;           
    char* ListenerShortName;      
    /* libmysofa handle, which is used if SAF_ENABLE_NETCDF is not defined */
    void* hLMSOFA;                
}saf_sofa_container;
 
typedef enum{
    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
 
} SAF_SOFA_ERROR_CODES;
 
 
/* ========================================================================== */
/*                              Main Functions                                */
/* ========================================================================== */
 
SAF_SOFA_ERROR_CODES saf_sofa_open(saf_sofa_container* hSOFA,
                                   char* sofa_filepath,
                                   SAF_SOFA_READER_OPTIONS option);
 
void saf_sofa_close(saf_sofa_container* hSOFA);
 
#endif /* SAF_ENABLE_SOFA_READER_MODULE */
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SAF_SOFA_READER_H_INCLUDED__ */
 
 /* doxygen addtogroup SOFA_Reader */