decorrelator_internal.h

Go to the documentation of this file.

/*
 * Copyright 2020 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 __DECORRELATOR_INTERNAL_H_INCLUDED__
#define __DECORRELATOR_INTERNAL_H_INCLUDED__
 
#include "decorrelator.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(DECORRELATOR_FRAME_SIZE)
# if defined(FRAME_SIZE) /* Use the global framesize if it is specified: */
#  define DECORRELATOR_FRAME_SIZE ( FRAME_SIZE )          
# else /* Otherwise, the default framesize for this example is: */
#  define DECORRELATOR_FRAME_SIZE ( 128 )                 
# endif
#endif
#define HOP_SIZE ( 128 )                                  
#define HYBRID_BANDS ( HOP_SIZE + 5 )                     
#define TIME_SLOTS ( DECORRELATOR_FRAME_SIZE / HOP_SIZE ) 
/* Checks: */
#if (DECORRELATOR_FRAME_SIZE % HOP_SIZE != 0)
# error "DECORRELATOR_FRAME_SIZE must be an integer multiple of HOP_SIZE"
#endif
    
/* ========================================================================== */
/*                                 Structures                                 */
/* ========================================================================== */
 
typedef struct _decorrelator
{
    /* audio buffers + afSTFT time-frequency transform handle */
    int fs;                           
    float** InputFrameTD;             
    float** OutputFrameTD;            
    float_complex*** InputFrameTF;    
    float_complex*** transientFrameTF; 
    float_complex*** OutputFrameTF;   
    void* hSTFT;                      
    int afSTFTdelay;                  
    float freqVector[HYBRID_BANDS];   
    /* our codec configuration */
    void* hDecor;                     
    void* hDucker;                    
    CODEC_STATUS codecStatus;         
    float progressBar0_1;             
    char* progressBarText;            
    /* internal variables */
    PROC_STATUS procStatus;           
    int new_nChannels;                
    /* user parameters */
    int nChannels;                    
    int enableTransientDucker;        
    float decorAmount;                
    int compensateLevel;              
} decorrelator_data;
 
 
/* ========================================================================== */
/*                             Internal Functions                             */
/* ========================================================================== */
 
void decorrelator_setCodecStatus(void* const hDecor,
                                 CODEC_STATUS newStatus);
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __DECORRELATOR_INTERNAL_H_INCLUDED__ */