saf_hades_analysis.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_ANALYSIS_H_INCLUDED__
#define __SAF_HADES_ANALYSIS_H_INCLUDED__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#ifdef  SAF_ENABLE_HADES_MODULE
 
#define HADES_MAX_NMICS ( 64 )
 
typedef struct _hades_analysis_data* hades_analysis_handle;
 
typedef struct _hades_param_container_data* hades_param_container_handle;
 
typedef struct _hades_signal_container_data* hades_signal_container_handle;
 
/* ========================================================================== */
/*                   HADES Analysis Configurations Options                    */
/* ========================================================================== */
 
typedef enum {
    HADES_USE_COMEDIE 
}HADES_DIFFUSENESS_ESTIMATORS;
 
typedef enum {
    HADES_USE_MUSIC      
}HADES_DOA_ESTIMATORS;
 
typedef enum {
    HADES_USE_AFSTFT_LD, 
    HADES_USE_AFSTFT     
}HADES_FILTERBANKS;
 
 
/* ========================================================================== */
/*                              HADES Analysis                                */
/* ========================================================================== */
 
void hades_analysis_create(/* Input Arguments */
                           hades_analysis_handle* const phAna,
                           float fs,
                           HADES_FILTERBANKS fbOption,
                           int hopsize,
                           int blocksize,
                           int hybridmode,
                           float* h_array,
                           float* grid_dirs_deg,
                           int nGrid,
                           int nMics,
                           int h_len,
                           HADES_DIFFUSENESS_ESTIMATORS diffOption,
                           HADES_DOA_ESTIMATORS doaOption);
 
void hades_analysis_destroy(/* Input Arguments */
                            hades_analysis_handle* const phAna);
 
void hades_analysis_reset(hades_analysis_handle const hAna);
 
void hades_analysis_apply(/* Input Arguments */
                          hades_analysis_handle const hAna,
                          float** input,
                          int nChannels,
                          int blocksize,
                          /* Output Arguments */
                          void* const hPCon,
                          void* const hSCon);
 
const float* hades_analysis_getFrequencyVectorPtr(/* Input Arguments */
                                                  hades_analysis_handle const hAna,
                                                  /* Output Arguments */
                                                  int* nBands);
 
int hades_analysis_getNbands(hades_analysis_handle const hAna);
 
float* hades_analysis_getCovarianceAvagingCoeffPtr(hades_analysis_handle const hAna);
 
int hades_analysis_getProcDelay(hades_analysis_handle const hAna);
 
 
/* ========================================================================== */
/*                      Parameter and Signal Containers                       */
/* ========================================================================== */
 
void hades_param_container_create(/* Input Arguments */
                                  hades_param_container_handle* const phPCon,
                                  hades_analysis_handle const hAna);
 
void hades_param_container_destroy(/* Input Arguments */
                                   hades_param_container_handle* const phPCon);
 
void hades_signal_container_create(hades_signal_container_handle* const phSCon,
                                   hades_analysis_handle const hAna);
 
void hades_signal_container_destroy(/* Input Arguments */
                                    hades_signal_container_handle* const phSCon);
 
#endif /* SAF_ENABLE_HADES_MODULE */
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SAF_HADES_ANALYSIS_H_INCLUDED__ */