ambi_enc.h

A basic Ambisonic encoder.

A basic Ambisonic encoder

Files

ambi_enc.h (include), ambi_enc_internal.h, ambi_enc.c, ambi_enc_internal.c

Include Header

/*
 * Copyright 2016-2018 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_ENC_H_INCLUDED__
#define __AMBI_ENC_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void ambi_enc_create(void** const phAmbi);
 
void ambi_enc_destroy(void** const phAmbi);
 
void ambi_enc_init(void* const hAmbi,
                     int samplerate);
 
void ambi_enc_process(void* const hAmbi,
                      const float *const * inputs,
                      float* const* outputs,
                      int nInputs,
                      int nOutputs,
                      int nSamples);
 
    
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void ambi_enc_refreshParams(void* const hAmbi);
    
void ambi_enc_setOutputOrder(void* const hAmbi, int newValue);
 
void ambi_enc_setSourceAzi_deg(void* const hAmbi, int index, float newAzi_deg);
 
void ambi_enc_setSourceElev_deg(void* const hAmbi, int index, float newElev_deg);
 
void ambi_enc_setNumSources(void* const hAmbi, int new_nSources);
 
void ambi_enc_setInputConfigPreset(void* const hAmbi, int newPresetID);
 
void ambi_enc_setChOrder(void* const hAmbi, int newOrder);
 
void ambi_enc_setNormType(void* const hAmbi, int newType);
 
void ambi_enc_setEnablePostScaling(void* const hAmbi, int newStatus);
 
 
void ambi_enc_setSourceGain(void* const hAmbi, int srcIdx, float newGain);
 
void ambi_enc_setSourceSolo(void* const hAmbi, int srcIdx);
 
void ambi_enc_setUnSolo(void* const hAmbi);
 
    
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int ambi_enc_getFrameSize(void);
 
int ambi_enc_getOutputOrder(void* const hAmbi);
 
float ambi_enc_getSourceAzi_deg(void* const hAmbi, int index);
 
float ambi_enc_getSourceElev_deg(void* const hAmbi, int index);
 
int ambi_enc_getNumSources(void* const hAmbi);
 
int ambi_enc_getMaxNumSources(void);
 
int ambi_enc_getNSHrequired(void* const hAmbi);
 
int ambi_enc_getChOrder(void* const hAmbi);
    
int ambi_enc_getNormType(void* const hAmbi);
 
int ambi_enc_getEnablePostScaling(void* const hAmbi);
 
int ambi_enc_getProcessingDelay(void);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __AMBI_ENC_H_INCLUDED__ */