saf_hades_synthesis.h

Go to the documentation of this file.

/*
 * This file is part of the saf_hades module.
 * Copyright (c) 2021 - Leo McCormack & Janani Fernandez
 *
 * The saf_hades module is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * The saf_hades module is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * See <http://www.gnu.org/licenses/> for a copy of the GNU General Public
 * License.
 */
 
#ifndef __SAF_HADES_SYNTHESIS_H_INCLUDED__
#define __SAF_HADES_SYNTHESIS_H_INCLUDED__
 
#include "saf_hades_analysis.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#ifdef  SAF_ENABLE_HADES_MODULE
 
typedef struct _hades_synthesis_data* hades_synthesis_handle;
 
typedef struct _hades_radial_editor_data* hades_radial_editor_handle;
 
/* ========================================================================== */
/*                   HADES Synthesis Configurations Options                   */
/* ========================================================================== */
 
typedef struct _hades_binaural_config{
    int lHRIR;                  
    int nHRIR;                  
    int hrir_fs;                
    float* hrirs;               
    float* hrir_dirs_deg;       
}hades_binaural_config;
 
typedef enum {
    HADES_BEAMFORMER_NONE,            
    HADES_BEAMFORMER_FILTER_AND_SUM,  
    HADES_BEAMFORMER_BMVDR            
}HADES_BEAMFORMER_TYPE;
 
typedef enum {
    HADES_HRTF_INTERP_NEAREST,    
    HADES_HRTF_INTERP_TRIANGULAR  
}HADES_HRTF_INTERP_OPTIONS;
 
 
/* ========================================================================== */
/*                            HADES Radial Editor                             */
/* ========================================================================== */
 
void hades_radial_editor_create(/* Input Arguments */
                                hades_radial_editor_handle* const phREd,
                                hades_analysis_handle const hAna);
 
void hades_radial_editor_destroy(/* Input Arguments */
                                 hades_radial_editor_handle* const phREd);
 
void hades_radial_editor_apply(/* Input Arguments */
                               hades_radial_editor_handle const hREd,
                               hades_param_container_handle  const hPCon,
                               float dirGain_dB[360]);
 
 
/* ========================================================================== */
/*                              HADES Synthesis                               */
/* ========================================================================== */
 
void hades_synthesis_create(/* Input Arguments */
                            hades_synthesis_handle* const phSyn,
                            hades_analysis_handle const hAna,
                            HADES_BEAMFORMER_TYPE beamOption,
                            int enableCM,
                            int refIndices[2],
                            hades_binaural_config* binConfig,
                            HADES_HRTF_INTERP_OPTIONS interpOption);
 
void hades_synthesis_destroy(/* Input Arguments */
                             hades_synthesis_handle* const phSyn);
 
void hades_synthesis_reset(hades_synthesis_handle const hSyn);
 
void hades_synthesis_apply(/* Input Arguments */
                           hades_synthesis_handle const hSyn,
                           hades_param_container_handle  const hPCon,
                           hades_signal_container_handle const hSCon,
                           int nChannels,
                           int blocksize,
                           /* Output Arguments */
                           float** output);
 
float* hades_synthesis_getEqPtr(hades_synthesis_handle const hSyn,
                                int* nBands);
 
float* hades_synthesis_getStreamBalancePtr(hades_synthesis_handle const hSyn,
                                           int* nBands);
 
float* hades_synthesis_getSynthesisAveragingCoeffPtr(hades_synthesis_handle const hSyn);
 
int hades_synthesis_getProcDelay(hades_synthesis_handle const hSyn);
 
#endif /* SAF_ENABLE_HADES_MODULE */
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SAF_HADES_SYNTHESIS_H_INCLUDED__ */