dirass.h

A sound-field visualiser based on the directional re-assignment of beamformer energy based on local DoA estimates.

A sound-field visualiser based on the directional re-assignment of beamformer energy based on local DoA estimates

Files

dirass.h (include), dirass_internal.h, dirass.c, dirass_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 __DIRASS_H_INCLUDED__
#define __DIRASS_H_INCLUDED__
 
#include "_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                             Presets + Constants                            */
/* ========================================================================== */
 
typedef enum {
    UPSCALE_ORDER_FIRST = 1,   
    UPSCALE_ORDER_SECOND,      
    UPSCALE_ORDER_THIRD,       
    UPSCALE_ORDER_FOURTH,      
    UPSCALE_ORDER_FIFTH,       
    UPSCALE_ORDER_SIXTH,       
    UPSCALE_ORDER_SEVENTH,     
    UPSCALE_ORDER_EIGHTH,      
    UPSCALE_ORDER_NINTH,       
    UPSCALE_ORDER_TENTH,       
    UPSCALE_ORDER_ELEVENTH,    
    UPSCALE_ORDER_TWELFTH,     
    UPSCALE_ORDER_THIRTEENTH,  
    UPSCALE_ORDER_FOURTEENTH,  
    UPSCALE_ORDER_FIFTEENTH,   
    UPSCALE_ORDER_SIXTHTEENTH, 
    UPSCALE_ORDER_SEVENTEENTH, 
    UPSCALE_ORDER_EIGHTEENTH,  
    UPSCALE_ORDER_NINETEENTH,  
    UPSCALE_ORDER_TWENTIETH    
}DIRASS_UPSCALE_ORDERS;
   
typedef enum {
    T_DESIGN_3 = 1,    
    T_DESIGN_4,        
    T_DESIGN_6,        
    T_DESIGN_9,        
    T_DESIGN_13,       
    T_DESIGN_18,       
    GRID_GEOSPHERE_6,  
    T_DESIGN_30,       
    GRID_GEOSPHERE_8,  
    GRID_GEOSPHERE_9,  
    GRID_GEOSPHERE_10, 
    GRID_GEOSPHERE_12  
}DIRASS_GRID_OPTIONS;
 
typedef enum {
    REASS_MODE_OFF = 1, 
    REASS_NEAREST,      
    REASS_UPSCALE       
} DIRASS_REASS_MODES;
 
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void dirass_create(void** const phDir);
 
void dirass_destroy(void** const phDir);
 
void dirass_init(void* const hDir,
                 float  samplerate);
    
void dirass_initCodec(void* const hDir);
 
void dirass_analysis(void* const hDir,
                     const float *const * inputs,
                     int nInputs,
                     int nSamples,
                     int isPlaying);
    
   
/* ========================================================================== */
/*                                Set Functions                               */
/* ========================================================================== */
 
void dirass_refreshSettings(void* const hDir);
    
void dirass_setBeamType(void* const hDir, int newType);
    
void dirass_setInputOrder(void* const hDir,  int newValue);
    
void dirass_setDisplayGridOption(void* const hDir,  int newOption);
   
void dirass_setDispWidth(void* const hDir,  int newValue);
    
void dirass_setUpscaleOrder(void* const hDir,  int newOrder);
    
void dirass_setDiRAssMode(void* const hDir,  int newMode);
    
void dirass_setMinFreq(void* const hDir,  float newValue);
 
void dirass_setMaxFreq(void* const hDir,  float newValue);
 
void dirass_setChOrder(void* const hDir, int newOrder);
 
void dirass_setNormType(void* const hDir, int newType);
 
void dirass_setDispFOV(void* const hDir, int newOption);
    
void dirass_setAspectRatio(void* const hDir, int newOption);
    
void dirass_setMapAvgCoeff(void* const hDir, float newValue);
    
void dirass_requestPmapUpdate(void* const hDir);
    
 
/* ========================================================================== */
/*                                Get Functions                               */
/* ========================================================================== */
 
int dirass_getFrameSize(void);
 
CODEC_STATUS dirass_getCodecStatus(void* const hDir);
 
float dirass_getProgressBar0_1(void* const hDir);
 
void dirass_getProgressBarText(void* const hDir, char* text);
 
int dirass_getInputOrder(void* const hDir);
    
int dirass_getBeamType(void* const hDir);
 
int dirass_getDisplayGridOption(void* const hDir);
 
int dirass_getDispWidth(void* const hDir);
 
int dirass_getUpscaleOrder(void* const hDir);
 
int dirass_getDiRAssMode(void* const hDir); 
 
float dirass_getMinFreq(void* const hDir);
 
float dirass_getMaxFreq(void* const hDir);
 
int dirass_getSamplingRate(void* const hDir); 
    
int dirass_getNSHrequired(void* const hDir);
 
int dirass_getChOrder(void* const hDir);
 
int dirass_getNormType(void* const hDir);
 
int dirass_getDispFOV(void* const hDir);
 
int dirass_getAspectRatio(void* const hDir);
 
float dirass_getMapAvgCoeff(void* const hDir);
    
int dirass_getPmap(void* const hDir,
                   float** grid_dirs,
                   float** pmap,
                   int* nDirs,
                   int* pmapWidth,
                   int* hfov,
                   float* aspectRatio);
 
int dirass_getProcessingDelay(void);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __DIRASS_H_INCLUDED__ */