binauraliser_nf.h

Go to the documentation of this file.

/*
 * Copyright 2022 Michael McCrea, 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 __BINAURALISER_NF_H_INCLUDED__
#define __BINAURALISER_NF_H_INCLUDED__
 
#include <binauraliser.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void binauraliserNF_create(void** const phBin);
 
void binauraliserNF_destroy(void** const phBin);
 
void binauraliserNF_init(void* const hBin,
                         int samplerate);
 
/* See the source definition for a note on redundancy with binauraliser_initCodec. */
void binauraliserNF_initCodec(void* const hBin);
 
void binauraliserNF_process(void* const hBin,
                            const float *const * inputs,
                            float* const* outputs,
                            int nInputs,
                            int nOutputs,
                            int nSamples);
 
void binauraliserNF_processFD(void* const hBin,
                          const float *const * inputs,
                          float* const* outputs,
                          int nInputs,
                          int nOutputs,
                          int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void binauraliserNF_setSourceDist_m(void* const hBin,
                                    int index,
                                    float newDist_m);
 
void binauraliserNF_setInputConfigPreset(void* const hBin,
                                         int newPresetID);
 
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
float binauraliserNF_getSourceDist_m(void* const hBin, int index);
 
float binauraliserNF_getFarfieldThresh_m(void* const hBin);
 
float binauraliserNF_getFarfieldHeadroom(void* const hBin);
 
float binauraliserNF_getNearfieldLimit_m(void* const hBin);
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __BINAURALISER_NF_H_INCLUDED__ */