tvconv.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 __TVCONV_H_INCLUDED__
#define __TVCONV_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum {
    SAF_TVCONV_NOT_INIT,
    SAF_TVCONV_SOFA_LOADING,
    SAF_TVCONV_SOFA_OK,
    SAF_TVCONV_SOFA_ERROR_INVALID_FILE_OR_FILE_PATH,
    SAF_TVCONV_SOFA_ERROR_DIMENSIONS_UNEXPECTED,
    SAF_TVCONV_SOFA_ERROR_FORMAT_UNEXPECTED,
    SAF_TVCONV_SOFA_ERROR_NETCDF_IN_USE
 
} SAF_TVCONV_ERROR_CODES;
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void tvconv_create(void** const phTVCnv);
 
void tvconv_destroy(void** const phTVCnv);
 
void tvconv_init(void* const hTVCnv,
                 int samplerate,
                 int hostBlockSize);
 
void tvconv_process(void* const hTVCnv,
                    float* const* const inputs,
                    float* const* const outputs,
                    int nInputs,
                    int nOutputs,
                    int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
    
void tvconv_refreshParams(void* const hTVCnv);
 
void tvconv_checkReInit(void* const hTVCnv);
 
void tvconv_setFiltersAndPositions(void* const hTVCnv);
 
void tvconv_setSofaFilePath(void* const hTVCnv, const char* path);
 
void tvconv_setTargetPosition(void* const hTVCnv, float position, int dim);
 
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int tvconv_getFrameSize(void);
 
    
int tvconv_getNumInputChannels(void* const hTVCnv);
 
int tvconv_getNumOutputChannels(void* const hTVCnv);
 
int tvconv_getHostBlockSize(void* const hTVCnv);
 
int tvconv_getNumIRs(void* const hTVCnv);
 
int tvconv_getNumListenerPositions(void* const hTVCnv);
 
float tvconv_getListenerPosition(void* const hTVCnv, int index, int dim);
 
int tvconv_getListenerPositionIdx(void* const hTVCnv);
 
float tvconv_getTargetPosition(void* const hTVCnv, int dim);
 
float tvconv_getSourcePosition(void* const hTVCnv, int dim);
 
float tvconv_getMinDimension(void* const hTVCnv, int dim);
 
float tvconv_getMaxDimension(void* const hTVCnv, int dim);
 
int tvconv_getIRLength(void* const hTVCnv);
 
int tvconv_getIRFs(void* const hTVCnv);
 
int tvconv_getHostFs(void* const hTVCnv);
 
int tvconv_getProcessingDelay(void* const hTVCnv);
 
char* tvconv_getSofaFilePath(void* const hTVCnv);
 
SAF_TVCONV_ERROR_CODES tvconv_getSofaErrorState(void* const hTVCnv);
 
CODEC_STATUS tvconv_getCodecStatus(void* const hTVCnv);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __TVCONV_H_INCLUDED__ */