spreader_internal.h

Go to the documentation of this file.

/*
 * Copyright 2021 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 __SPREADER_INTERNAL_H_INCLUDED__
#define __SPREADER_INTERNAL_H_INCLUDED__
 
#include "spreader.h"      /* Include header for this example */
#include "saf.h"           /* Main include header for SAF */
#include "saf_externals.h" /* To also include SAF dependencies (cblas etc.) */
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ========================================================================== */
/*                            Internal Parameters                             */
/* ========================================================================== */
 
#if !defined(SPREADER_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define SPREADER_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define SPREADER_FRAME_SIZE ( 512 )                 
# endif
#endif
#define MAX_SPREAD_FREQ ( 16e3f )                     
#define HOP_SIZE ( 128 )                              
#define HYBRID_BANDS ( HOP_SIZE + 5 )                 
#define TIME_SLOTS ( SPREADER_FRAME_SIZE / HOP_SIZE ) 
 
/* Checks: */
#if (SPREADER_FRAME_SIZE % HOP_SIZE != 0)
# error "SPREADER_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
 
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && !defined(__STDC_NO_ATOMICS__)
  typedef _Atomic SPREADER_PROC_MODES _Atomic_SPREADER_PROC_MODES;
#else
  typedef SPREADER_PROC_MODES _Atomic_SPREADER_PROC_MODES;
#endif
 
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */

typedef struct _spreader
{
    /* audio buffers and time-frequency transform */
    float** inputFrameTD;              
    float** outframeTD;                
    float_complex*** inputframeTF;     
    float_complex*** protoframeTF;     
    float_complex*** decorframeTF;     
    float_complex*** spreadframeTF;    
    float_complex*** outputframeTF;    
    int fs;                            
    float freqVector[HYBRID_BANDS];    
    void* hSTFT;                       
 
    /* Internal */
    _Atomic_INT32 Q;                   
    _Atomic_INT32 nGrid;               
    _Atomic_INT32 h_len;               
    _Atomic_FLOAT32 h_fs;              
    float* h_grid;                     
    float_complex* H_grid;             
    float_complex** HHH[HYBRID_BANDS]; 
    float* grid_dirs_deg;              
    float* grid_dirs_xyz;              
    float* weights;                    
    void* hDecor[SPREADER_MAX_NUM_SOURCES]; 
    float* angles;                     
    float_complex** Cproto[SPREADER_MAX_NUM_SOURCES]; 
    float_complex** Cy[SPREADER_MAX_NUM_SOURCES];     
    float_complex** prev_M[SPREADER_MAX_NUM_SOURCES]; 
    float** prev_Mr[SPREADER_MAX_NUM_SOURCES];        
    float_complex** new_M;             
    float** new_Mr;                    
    float_complex* interp_M;           
    float* interp_Mr;                  
    float_complex* interp_Mr_cmplx;     
    float interpolatorFadeIn[TIME_SLOTS];  
    float interpolatorFadeOut[TIME_SLOTS]; 
 
    /* For visualisation */
    int* dirActive[SPREADER_MAX_NUM_SOURCES]; 
 
    /* Optimal mixing solution */
    void* hCdf;                        
    void* hCdf_res;                    
    float* Qmix;                       
    float_complex* Qmix_cmplx;         
    float* Cr;                         
    float_complex* Cr_cmplx;           
    
    // Hotfix:
    float_complex* _tmpFrame, *_H_tmp, *_Cy;
    float_complex* _E_dir, *_V, *_D;
    float_complex* _Cproto;
 
    /* flags/status */
    _Atomic_CODEC_STATUS codecStatus;            
    _Atomic_FLOAT32 progressBar0_1;              
    char* progressBarText;                       
    _Atomic_PROC_STATUS procStatus;              
    _Atomic_INT32 new_nSources;                  
    _Atomic_SPREADER_PROC_MODES new_procMode;    
 
    /* user parameters */
    _Atomic_SPREADER_PROC_MODES procMode;        
    char* sofa_filepath;                         
    _Atomic_INT32 nSources;                      
    _Atomic_FLOAT32 src_spread[SPREADER_MAX_NUM_SOURCES];      
    _Atomic_FLOAT32 src_dirs_deg[SPREADER_MAX_NUM_SOURCES][2]; 
    _Atomic_INT32 useDefaultHRIRsFLAG;           
    _Atomic_FLOAT32 covAvgCoeff;                 
 
} spreader_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */

void spreader_setCodecStatus(void* const hSpr,
                             CODEC_STATUS newStatus);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __SPREADER_INTERNAL_H_INCLUDED__ */