saf_reverb.h

Go to the documentation of this file.

/*
 * Copyright 2020 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_REVERB_H_INCLUDED__
#define __SAF_REVERB_H_INCLUDED__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                         IMS Shoebox Room Simulator                         */
/* ========================================================================== */
/*
 * Note that this simulator is based on the shoebox-roomsim MATLAB library
 * found here: https://github.com/polarch/shoebox-roomsim
 * (Copyright (c) 2017, Archontis Politis, BSD-3-Clause License)
 */
 
#define IMS_MAX_NUM_SOURCES 128
 
#define IMS_MAX_NUM_RECEIVERS 16
 
typedef struct _ims_rir{
    float* data;        
    int length, nChannels;
} ims_rir;
 
void ims_shoebox_create(void** phIms,
                        float roomDimensions[3],
                        float* abs_wall,
                        float lowestOctaveBand,
                        int nOctBands,
                        float c_ms,
                        float fs);
 
void ims_shoebox_destroy(void** phIms);
 
void ims_shoebox_computeEchograms(void* hIms,
                                  int maxN,
                                  float maxTime_s);
 
void ims_shoebox_renderRIRs(void* hIms,
                            int fractionalDelaysFLAG);
 
void ims_shoebox_applyEchogramTD(/* Input Arguments */
                                 void* hIms,
                                 long receiverID,
                                 int nSamples,
                                 int fractionalDelaysFLAG);
 
 
/* =========================== Set/Get functions ============================ */
 
void ims_shoebox_setRoomDimensions(void* hIms,
                                   float new_roomDimensions[3]);
 
void ims_shoebox_setWallAbsCoeffs(void* hIms,
                                  float* abs_wall);
 
 
/* ================== Add/Remove/Update Objects functions ==================== */
 
int ims_shoebox_addSource(void* hIms,
                          float position_xyz[3],
                          float** pSrc_sig);
 
int ims_shoebox_addReceiverSH(void* hIms,
                              int sh_order,
                              float position_xyz[3],
                              float*** pSH_sigs);
 
void ims_shoebox_updateSource(void* hIms,
                              int sourceID,
                              float position_xyz[3]);
 
void ims_shoebox_updateReceiver(void* hIms,
                                int receiverID,
                                float position_xyz[3]);
 
void ims_shoebox_removeSource(void* hIms,
                              int sourceID);
 
void ims_shoebox_removeReceiver(void* hIms,
                                int receiverID);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif  /* __cplusplus */
 
#endif /* __SAF_REVERB_H_INCLUDED__ */
 
 /* doxygen addtogroup Reverb */