saf_vbap.h

Go to the documentation of this file.

/*
 * 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 __SAF_VBAP_H_INCLUDED__
#define __SAF_VBAP_H_INCLUDED__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                               Misc. Functions                              */
/* ========================================================================== */
 
void generateVBAPgainTable3D_srcs(/* Input arguments */
                                  float* src_dirs_deg,
                                  int S,
                                  float* ls_dirs_deg,
                                  int L,
                                  int omitLargeTriangles,
                                  int enableDummies,
                                  float spread,
                                  /* Output arguments */
                                  float** gtable,
                                  int* N_gtable,
                                  int* nTriangles);
 
void generateVBAPgainTable3D(/* Input arguments */
                             float* ls_dirs_deg,
                             int L,
                             int az_res_deg,
                             int el_res_deg,
                             int omitLargeTriangles,
                             int enableDummies,
                             float spread,
                             /* Output arguments */
                             float** gtable,
                             int* N_gtable,
                             int* nTriangles);
 
void compressVBAPgainTable3D(/* Input arguments */
                             float* vbap_gtable,
                             int nTable,
                             int nDirs,
                             /* Output arguments */
                             float* vbap_gtableComp,
                             int* vbap_gtableIdx);
 
void VBAPgainTable2InterpTable(float* vbap_gtable,
                               int nTable,
                               int nDirs);
 
void generateVBAPgainTable2D_srcs(/* Input arguments */
                                  float* src_dirs_deg,
                                  int S,
                                  float* ls_dirs_deg,
                                  int L,
                                  /* Output arguments */
                                  float** gtable,
                                  int* N_gtable,
                                  int* nPairs);
 
void generateVBAPgainTable2D(/* Input arguments */
                             float* ls_dirs_deg,
                             int L,
                             int az_res_deg,
                             /* Output arguments */
                             float** gtable,
                             int* N_gtable,
                             int* nPairs);
 
void getPvalues(/* Input arguments */
                float DTT,
                float* freq,
                int nFreq,
                /* Output arguments */
                float* pValues);
 
 
/* ========================================================================== */
/*                               Main Functions                               */
/* ========================================================================== */
/*
 * Note that the main functions are largely based on the VBAP Matlab library
 * (BSD-3-Clause License) found here:
 * https://github.com/polarch/Vector-Base-Amplitude-Panning
 */
 
void findLsTriplets(/* Input Arguments */
                    float* ls_dirs_deg,
                    int L,
                    int omitLargeTriangles,
                    /* Output Arguments */
                    float** out_vertices,
                    int* numOutVertices,
                    int** out_faces,
                    int* numOutFaces);
 
void invertLsMtx3D(/* Input Arguments */
                   float* U_spkr,
                   int* ls_groups,
                   int N_group,
                   /* Output Arguments */
                   float** layoutInvMtx);
 
void getSpreadSrcDirs3D(/* Input Arguments */
                        float src_azi_rad,
                        float src_elev_rad,
                        float spread,
                        int num_src,
                        int num_rings_3d,
                        /* Output Arguments */
                        float* U_spread);
 
void vbap3D(/* Input Arguments */
            float* src_dirs,
            int src_num,
            int ls_num,
            int* ls_groups,
            int nFaces,
            float spread,
            float* layoutInvMtx,
            /* Output Arguments */
            float** GainMtx);
 
void findLsPairs(/* Input Arguments */
                 float* ls_dirs_deg,
                 int L,
                 /* Output Arguments */
                 int** out_pairs,
                 int* numOutPairs);
 
void invertLsMtx2D(/* Input Arguments */
                   float* U_spkr,
                   int* ls_pairs,
                   int N_pairs,
                   /* Output Arguments */
                   float** layoutInvMtx);
 
void vbap2D(/* Input Arguments */
            float* src_dirs,
            int src_num,
            int ls_num,
            int* ls_pairs,
            int N_pairs,
            float* layoutInvMtx,
            /* Output Arguments */
            float** GainMtx);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __SAF_VBAP_H_INCLUDED__ */
 
 /* doxygen addtogroup VBAP */