panner.h

A frequency-dependent 3D panner based on the Vector-base Amplitude Panning (VBAP) method, with an optional spread control.

A frequency-dependent 3D panner based on the Vector-base Amplitude Panning (VBAP) method, with an optional spread control

Files

panner.h (include), panner_internal.h, panner.c, panner_internal.c

Include Header

/*
 * Copyright 2017-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 __PANNER_H_INCLUDED__
#define __PANNER_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
    
/* ========================================================================== */
/*                             Presets + Constants                            */
/* ========================================================================== */
 
#define PANNER_SPREAD_MIN_VALUE ( 0.0f )
 
#define PANNER_SPREAD_MAX_VALUE ( 90.0f )
    
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void panner_create(void** const phPan);
 
void panner_destroy(void** const phPan);
 
void panner_init(void* const hPan,
                 int samplerate);
    
void panner_initCodec(void* const hPan);
 
void panner_process(void* const hPan,
                    const float *const * inputs,
                    float* const* outputs,
                    int nInputs,
                    int nOutputs,
                    int nSamples);
    
    
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void panner_refreshSettings(void* const hPan);
 
void panner_setSourceAzi_deg(void* const hPan, int index, float newAzi_deg);
 
void panner_setSourceElev_deg(void* const hPan, int index, float newElev_deg);
 
void panner_setNumSources(void* const hPan, int new_nSources);
 
void panner_setLoudspeakerAzi_deg(void* const hPan, int index, float newAzi_deg);
 
void panner_setLoudspeakerElev_deg(void* const hPan, int index, float newElev_deg);
 
void panner_setNumLoudspeakers(void* const hPan, int new_nLoudspeakers);
 
void panner_setOutputConfigPreset(void* const hPan, int newPresetID);
 
void panner_setInputConfigPreset(void* const hPan, int newPresetID);
 
void panner_setDTT(void* const hPan, float newValue);
    
void panner_setSpread(void* const hPan, float newValue);
 
void panner_setYaw(void* const hPan, float newYaw);
 
void panner_setPitch(void* const hPan, float newPitch);
 
void panner_setRoll(void* const hPan, float newRoll);
 
void panner_setFlipYaw(void* const hPan, int newState);
 
void panner_setFlipPitch(void* const hPan, int newState);
 
void panner_setFlipRoll(void* const hPan, int newState);
    
    
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int panner_getFrameSize(void);
 
CODEC_STATUS panner_getCodecStatus(void* const hPan);
 
float panner_getProgressBar0_1(void* const hPan);
 
void panner_getProgressBarText(void* const hPan, char* text);
    
float panner_getSourceAzi_deg(void* const hPan, int index);
 
float panner_getSourceElev_deg(void* const hPan, int index);
 
int panner_getNumSources(void* const hPan);
 
int panner_getMaxNumSources(void);
 
float panner_getLoudspeakerAzi_deg(void* const hPan, int index);
 
float panner_getLoudspeakerElev_deg(void* const hPan, int index);
 
int panner_getNumLoudspeakers(void* const hPan);
 
int panner_getMaxNumLoudspeakers(void);
 
int panner_getDAWsamplerate(void* const hPan);
 
float panner_getDTT(void* const hPan);
 
float panner_getSpread(void* const hPan);
 
float panner_getYaw(void* const hPan);
 
float panner_getPitch(void* const hPan);
 
float panner_getRoll(void* const hPan);
 
int panner_getFlipYaw(void* const hPan);
 
int panner_getFlipPitch(void* const hPan);
 
int panner_getFlipRoll(void* const hPan);
 
int panner_getProcessingDelay(void);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __PANNER_H_INCLUDED__ */