saf_hoa.h

Go to the documentation of this file.

/*
 * Copyright 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 __SAF_HOA_H_INCLUDED__
#define __SAF_HOA_H_INCLUDED__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "../saf_utilities/saf_utility_complex.h"
 
/* ========================================================================== */
/*                                    Enums                                   */
/* ========================================================================== */
 
typedef enum {
    LOUDSPEAKER_DECODER_DEFAULT,
    LOUDSPEAKER_DECODER_SAD,
    LOUDSPEAKER_DECODER_MMD,
    LOUDSPEAKER_DECODER_EPAD,
    LOUDSPEAKER_DECODER_ALLRAD
    
} LOUDSPEAKER_AMBI_DECODER_METHODS;
 
typedef enum {
    BINAURAL_DECODER_DEFAULT,
    BINAURAL_DECODER_LS,
    BINAURAL_DECODER_LSDIFFEQ,
    BINAURAL_DECODER_SPR,
    BINAURAL_DECODER_TA,
    BINAURAL_DECODER_MAGLS
    
} BINAURAL_AMBI_DECODER_METHODS;
 
typedef enum {
    HOA_CH_ORDER_ACN,  
    HOA_CH_ORDER_FUMA  
}HOA_CH_ORDER;
 
typedef enum {
    HOA_NORM_N3D,  
    HOA_NORM_SN3D, 
    HOA_NORM_FUMA  
}HOA_NORM;
 
 
/* ========================================================================== */
/*                               Misc. Functions                              */
/* ========================================================================== */
 
void convertHOAChannelConvention(/* Input Arguments */
                                 float* insig,
                                 int order,
                                 int signalLength,
                                 HOA_CH_ORDER inConvention,
                                 HOA_CH_ORDER outConvention);
 
void convertHOANormConvention(/* Input Arguments */
                              float* insig,
                              int order,
                              int signalLength,
                              HOA_NORM inConvention,
                              HOA_NORM outConvention);
 
void getRSH(/* Input Arguments */
            int order,
            float* dirs_deg,
            int nDirs,
            /* Output Arguments */
            float* Y);
 
void getRSH_recur(/* Input Arguments */
                  int order,
                  float* dirs_deg,
                  int nDirs,
                  /* Output Arguments */
                  float* Y);
 
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
 
void getMaxREweights(/* Input Arguments */
                     int order,
                     int diagMtxFlag,
                     /* Output Arguments */
                     float* a_n);
 
void truncationEQ(/* Input arguments */
                   float* w_n,
                   int order_truncated,
                   int order_target,
                   double* kr,
                   int nBands,
                   float softThreshold,
                   /* Output arguments */
                   float* gain);
 
void getLoudspeakerDecoderMtx(/* Input Arguments */
                              float* ls_dirs_deg,
                              int nLS,
                              LOUDSPEAKER_AMBI_DECODER_METHODS method,
                              int order,
                              int enableMaxrE,
                              /* Output Arguments */
                              float* decMtx);
 
void getBinauralAmbiDecoderMtx(/* Input Arguments */
                               float_complex* hrtfs,
                               float* hrtf_dirs_deg,
                               int N_dirs,
                               int N_bands,
                               BINAURAL_AMBI_DECODER_METHODS method,
                               int order,
                               float* freqVector,
                               float* itd_s,
                               float* weights,
                               int enableDiffCM,
                               int enableMaxrE,
                               /* Output Arguments */
                               float_complex* decMtx);
 
void getBinauralAmbiDecoderFilters(/* Input Arguments */
                                   float_complex* hrtfs,
                                   float* hrtf_dirs_deg,
                                   int N_dirs,
                                   int fftSize,
                                   float fs,
                                   BINAURAL_AMBI_DECODER_METHODS method,
                                   int order,
                                   float* itd_s,
                                   float* weights,
                                   int enableDiffCM,
                                   int enableMaxrE,
                                   /* Output Arguments */
                                   float* decFilters);
 
void applyDiffCovMatching(/* Input Arguments */
                          float_complex* hrtfs,
                          float* hrtf_dirs_deg,
                          int N_dirs,
                          int N_bands,
                          int order,
                          float* weights,
                          /* Input/Output Arguments */
                          float_complex* decMtx);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SAF_HOA_H_INCLUDED__ */
 
 /* doxygen addtogroup HOA */