ambi_roomsim.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 __AMBI_ROOMSIM_H_INCLUDED__
#define __AMBI_ROOMSIM_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                             Presets + Constants                            */
/* ========================================================================== */

#define ROOM_SIM_MAX_NUM_RECEIVERS ( 16 )
#define ROOM_SIM_MAX_NUM_SOURCES ( 16 )

extern const float ambi_roomsim_default_abs_wall[6];

extern const float ambi_roomsim_default_room_dims[3];

extern const int ambi_roomsim_defaultNumSources;

extern const float ambi_roomsim_defaultSourcePositions[ROOM_SIM_MAX_NUM_SOURCES][3];

extern const int ambi_roomsim_defaultNumReceivers;

extern const float ambi_roomsim_defaultReceiverPositions[ROOM_SIM_MAX_NUM_RECEIVERS][3];
 
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */

void ambi_roomsim_create(void** const phAmbi);

void ambi_roomsim_destroy(void** const phAmbi);

void ambi_roomsim_init(void* const hAmbi,
                     int samplerate);

void ambi_roomsim_process(void* const hAmbi,
                          const float *const * inputs,
                          float* const* outputs,
                          int nInputs,
                          int nOutputs,
                          int nSamples);
 
    
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */

void ambi_roomsim_refreshParams(void* const hAmbi);

void ambi_roomsim_setEnableIMSflag(void* const hAmbi, int newValue);

void ambi_roomsim_setMaxReflectionOrder(void* const hAmbi, int newValue);
    
void ambi_roomsim_setOutputOrder(void* const hAmbi, int newValue);

void ambi_roomsim_setNumSources(void* const hAmbi, int new_nSources);

void ambi_roomsim_setSourceX(void* const hAmbi, int index, float newValue);

void ambi_roomsim_setSourceY(void* const hAmbi, int index, float newValue);

void ambi_roomsim_setSourceZ(void* const hAmbi, int index, float newValue);

void ambi_roomsim_setNumReceivers(void* const hAmbi, int new_nReceievers);

void ambi_roomsim_setReceiverX(void* const hAmbi, int index, float newValue);

void ambi_roomsim_setReceiverY(void* const hAmbi, int index, float newValue);

void ambi_roomsim_setReceiverZ(void* const hAmbi, int index, float newValue);

void ambi_roomsim_setRoomDimX(void* const hAmbi, float newValue);

void ambi_roomsim_setRoomDimY(void* const hAmbi, float newValue);

void ambi_roomsim_setRoomDimZ(void* const hAmbi, float newValue);

void ambi_roomsim_setWallAbsCoeff(void* const hAmbi, int xyz_idx, int posNeg_idx, float new_value);

void ambi_roomsim_setChOrder(void* const hAmbi, int newOrder);

void ambi_roomsim_setNormType(void* const hAmbi, int newType);
 
    
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */

int ambi_roomsim_getFrameSize(void);

int ambi_roomsim_getEnableIMSflag(void* const hAmbi);

int ambi_roomsim_getMaxReflectionOrder(void* const hAmbi);

int ambi_roomsim_getOutputOrder(void* const hAmbi);

int ambi_roomsim_getNumSources(void* const hAmbi);

int ambi_roomsim_getMaxNumSources(void);

int ambi_roomsim_getNSHrequired(void* const hAmbi);

float ambi_roomsim_getSourceX(void* const hAmbi, int index);

float ambi_roomsim_getSourceY(void* const hAmbi, int index);

float ambi_roomsim_getSourceZ(void* const hAmbi, int index);

int ambi_roomsim_getNumReceivers(void* const hAmbi);

int ambi_roomsim_getMaxNumReceivers(void);

float ambi_roomsim_getReceiverX(void* const hAmbi, int index);

float ambi_roomsim_getReceiverY(void* const hAmbi, int index);

float ambi_roomsim_getReceiverZ(void* const hAmbi, int index);

float ambi_roomsim_getRoomDimX(void* const hAmbi);

float ambi_roomsim_getRoomDimY(void* const hAmbi);

float ambi_roomsim_getRoomDimZ(void* const hAmbi);

float ambi_roomsim_getWallAbsCoeff(void* const hAmbi,
                                   int xyz_idx,
                                   int posNeg_idx);

int ambi_roomsim_getChOrder(void* const hAmbi);
    
int ambi_roomsim_getNormType(void* const hAmbi);
 
int ambi_roomsim_getProcessingDelay(void);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __AMBI_ROOMSIM_H_INCLUDED__ */