matrixconv.h

A standard matrix convolver.

A standard matrix convolver

Files

matrixconv.h (include), matrixconv_internal.h, matrixconv.c, matrixconv_internal.c

Include Header

/*
 * Copyright 2019 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 __MATRIXCONV_H_INCLUDED__
#define __MATRIXCONV_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void matrixconv_create(void** const phMCnv);
 
void matrixconv_destroy(void** const phMCnv);
 
void matrixconv_init(void* const hMCnv,
                     int samplerate,
                     int hostBlockSize);
 
void matrixconv_process(void* const hMCnv,
                        const float *const * inputs,
                        float* const* const outputs,
                        int nInputs,
                        int nOutputs,
                        int nSamples);
 
 
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
    
void matrixconv_refreshParams(void* const hMCnv);
 
void matrixconv_checkReInit(void* const hMCnv);
 
void matrixconv_setFilters(void* const hMCnv,
                           const float* const* H,
                           int numChannels,
                           int numSamples,
                           int sampleRate);
 
void matrixconv_setEnablePart(void* const hMCnv, int newState);
    
void matrixconv_setNumInputChannels(void* const hMCnv, int newValue);
    
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int matrixconv_getFrameSize(void);
 
int matrixconv_getEnablePart(void* const hMCnv);
    
int matrixconv_getNumInputChannels(void* const hMCnv);
 
int matrixconv_getNumOutputChannels(void* const hMCnv);
 
int matrixconv_getHostBlockSize(void* const hMCnv);
 
int matrixconv_getNfilters(void* const hMCnv);
 
int matrixconv_getFilterLength(void* const hMCnv);
 
int matrixconv_getFilterFs(void* const hMCnv);
 
int matrixconv_getHostFs(void* const hMCnv);
 
int matrixconv_getProcessingDelay(void* const hMCnv);
    
    
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __MATRIXCONV_H_INCLUDED__ */